diff --git a/_data/actions.csv b/_data/actions.csv index 1baeb183a..01c765b94 100644 --- a/_data/actions.csv +++ b/_data/actions.csv @@ -20,5 +20,5 @@ oh1,tinkerforge,TinkerForge,"The TinkerForge Action service provides direct inte oh1,twitter,Twitter,"Twitter can be used to 'tweet' notifications when certain events take place in openHAB." oh1,weather,Weather,"The Weather Action service provides meteorological information to your scripts and rules." oh1,xbmc,XBMC,"Sends notifications to the Kodi open source home theater software (formerly known as XBMC)." -oh1,xmpp,XMPP,"* `sendXMPP(String to, String message)`: Sends a message to an XMPP user" +oh1,xmpp,XMPP,"This set of actions allows you to send a message to an XMPP user or multi-user chat, or send a message with an attachment to an XMPP user." oh1,xpl,xPL,"This add-on provides xPL message sending on the network." diff --git a/_data/bindings.csv b/_data/bindings.csv index b217a5d57..f2d89123e 100644 --- a/_data/bindings.csv +++ b/_data/bindings.csv @@ -1,10 +1,10 @@ source,id,label,description -oh1,akm868,AKM868,"This binding is for users coming from the proprietary homeautomation-system 'IP-Symcon'. If you have bought some hardware from them, you can use this binding to enable your AKM868 presence detection system. The following hardware was used to do presence detection with the AKM-868 controller and a OVO868-tracker for your key-ring:" -oh1,alarmdecoder,Alarm Decoder,"The [Alarm Decoder](http://www.alarmdecoder.com) is a hardware adapter that interfaces with Ademco/Honeywell alarm panels. It acts" +oh1,akm868,AKM868,"This binding is for users coming from the proprietary homeautomation-system 'IP-Symcon'. If you have bought some hardware from them, you can use this binding to enable your AKM868 presence detection system." +oh1,alarmdecoder,Alarm Decoder,"The [Alarm Decoder](http://www.alarmdecoder.com) is a hardware adapter that interfaces with Ademco/Honeywell alarm panels. It acts essentially like a keypad, reading and writing messages on a serial bus that connects keypads with the main panel." oh1,anel,Anel binding,"The Anel binding is for monitoring and controlling NET-PwrCtrl devices." -oh1,asterisk,Asterisk,"The Asterisk binding is used to enable communication between openhab and the free and open source PBX solution [Asterisk](http://www.asterisk.org). By help of this binding, you can e.g. detect incoming phone calls or determine if someone currently does a phone call. In combination with other bindings (e.g. the Samsung TV Binding) you can display caller IDs on your TV." +oh1,asterisk,Asterisk,"The Asterisk binding is used to enable communication between openhab and the free and open source PBX solution [Asterisk](http://www.asterisk.org). This binding detects incoming phone calls or if someone makes a phone call. In combination with other bindings (e.g., the Samsung TV Binding) you can display caller IDs on your TV." oh1,astro,Astro,"The Astro binding is used for calculating many `DateTime` and positional values for sun and moon and for scheduling of events." -oh1,autelis,Autelis,"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." +oh1,autelis,Autelis,"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." oh1,benqprojector,BenQ Projector,"This binding is designed to interface with BenQ projectors that have an RS232 interface on them that accepts the commands documented by BenQ [here](ftp://ftp.benq-eu.com/projector/benq_rs232_commands.pdf)." oh1,bluetooth,Bluetooth,"The Bluetooth binding is used to connect openHAB with a Bluetooth device. With it, you can make openHAB react to Bluetooth devices that come in range of your network." oh1,bticino,Bticino,"The openHAB Bticino binding allows openHAB to connect to Bticino My Home Automation installations by OpenWebNet protocol." @@ -13,7 +13,7 @@ oh1,caldav-personal,CalDAV Personal,"This binding can be used to connect through oh1,comfoair,ComfoAir,"This binding should be compatible with the Zehnder ComfoAir 350 ventilation system. ComfoAir 550 is untested but should supposedly use the same protocol. The same is true for the device WHR930 of StorkAir, G90-380 by Wernig and Santos 370 DC to Paul." oh1,configadmin,ConfigAdmin,"With this binding it is possible to dynamically change settings that are defined in the Configuration Admin Manager of OSGi, where all configuration data are kept for openHAB. The various `.cfg` files are as such used to define the initial configuration, while you can use this binding to change values during runtime, simply by sending a command to an item." oh1,cups,CUPS,"The openHAB CUPS binding allows interaction with printers and their print queues via a CUPS server." -oh1,daikin,Daikin,"The openHAB Daikin binding allows monitoring and control of a Daikin air" +oh1,daikin,Daikin,"The Daikin binding allows monitoring and control of a Daikin air conditioner or heat pump, through either the KKRP01A wired module or the BRP072A42 wireless module." oh1,davis,Davis,"The openHAB Davis binding supports reading data from Davis weather stations. Most Davis weather stations should be supported." oh1,ddwrt,DD-WRT,"The openHAB DD-WRT Binding allows interaction with a DD-WRT device." oh1,denon,Denon,"The openHAB Denon Binding allows interaction with Denon AV receivers. It should be compatible with previous generation receivers such as AVR-X2000/X3000, as well as current ones such as X2100W/X3100W." @@ -21,7 +21,7 @@ oh1,digitalstrom,digitalSTROM,"The openHAB digitalSTROM binding allows interacti oh1,diyonxbee,DIYOnXBee,"The openHAB DIYOnXBee binding allows interaction with self built (DIY) hardware that communicate via XBee modules." oh1,dmx,DMX,"The openHAB DMX binding can control DMX devices like RGB LED strips, dimmers" oh1,dscalarm,DSC PowerSeries Alarm System,"This binding mintors and controls the DSC PowerSeries Alarm System, utilizing the EyezOn Envisalink 3/2DS interface or the DSC IT-100 RS-232 interface." -oh1,dsmr,DSMR,"The openHAB DSMR binding is targeted for Dutch users having a smart meter" +oh1,dsmr,DSMR,"The openHAB DSMR binding is targeted for Dutch users having a smart meter ('Slimme meter' in Dutch). Data of Dutch smart meters can be obtained via the P1-port. When connecting this port from a serial port the data can be read out." oh1,ebus,eBUS,"The eBUS binding allows you to control your heating system. The eBUS protocol is used by heating system vendors like Wolf, Vaillant, Kromschröder etc. You can read temperatures, pump performance, gas consumption etc." oh1,ecobee,Ecobee,"Ecobee Inc. of Toronto, Canada, sells a range of Wi-Fi enabled thermostats, principally in the Americas. The EMS, EMS Si, Smart, Smart Si and ecobee3 models are supported by this binding, which communicates with the [Ecobee API](https://www.ecobee.com/home/developer/api/documentation/v1/index.shtml) over a secure, RESTful API to Ecobee's servers. Monitoring ambient temperature and humidity, changing HVAC mode, changing heat or cool setpoints, changing the backlight intensity, and even sending textual messages to one or a group of thermostats, can be accomplished through this binding." oh1,ecotouch,EcoTouch,"The openHAB EcoTouch binding allows interaction with a heat pump." @@ -36,22 +36,22 @@ oh1,fatekplc,Fatek PLC,"[Fatek PLC](http://fatek.com/en/prod.php?catId=1) is one oh1,fht,FHT,"FHT is a range of devices produced by busware.de which allows to interact with various protocols and devices over radio frequencies. It's also possible to build one on your own." oh1,freebox,Freebox,"This binding is intended for users of the French DSL operator Free, using Freebox Revolution (v6)." oh1,freeswitch,FreeSWITCH,"The FreeSWITCH Binding connects to a FreeSWITCH instance and can report on current active calls as well as show unread voicemails and if a MWI is on." -oh1,fritzaha,Fritz AHA,"[![Fritz AHA](http://img.youtube.com/vi/qYrpPrLY868/0.jpg)](http://www.youtube.com/watch?v=qYrpPrLY868)" +oh1,fritzaha,Fritz AHA,"This binding provides access to AVM Home Automation devices, such as the Fritz!DECT 200 connected to a Fritz!Box or the Fritz!Powerline 546E. It is designed to allow for multiple hosts, for instance using both a Fritz!Box and a Fritz!Powerline." oh1,fritzbox,Fritz!Box,"This binding can be configured in the `services/fritzbox.cfg` file." -oh1,fritzboxtr064,Fritzbox (using TR064 protocol),"This is a binding for communication with AVM Fritz!Box using SOAP requests (TR064 protocol). It has been tested on:" +oh1,fritzboxtr064,Fritzbox (using TR064 protocol),"This is a binding for communication with AVM Fritz!Box using SOAP requests (TR064 protocol)." oh1,frontiersiliconradio,Frontier Silicon Radio,"This binding is for internet radios based on the [Frontier Silicon chipset](http://www.frontier-silicon.com/digital-radio-solutions)." oh1,fs20,FS20,"This binding enables support of sending and receiving FS20 messages via the CUL transport. You will need CULLite or similiar device from busware.de. This device needs to be flashed with the latest culfw firmware from culfw.de." oh1,garadget,Garadget,"The [Garadget](http://garadget.com) is cloud-based device that 'futurizes' your existing garage door opener, letting you open and close your garage door from anywhere, including via openHAB with this binding. Remote access is made possible with the [particle.io](https://www.particle.io/) REST API." -oh1,gc100ir,Global Cache IR (1.x),"This page describes the Global Cache IR binding (1.x), which allows openHAB items to send commands to the corresponding IR devices from one or more instances of Global Cache." -oh1,gpio,GPIO,"This binding for the local GPIO subsystem, currently only this exposed to user space by [Linux GPIO framework](https://www.kernel.org/doc/Documentation/gpio/sysfs.txt) is implemented. Being based on kernel implementation it's hardware agnostic and works on different boards without modification (this is on theory only, not all existing boards can be tested). The difference from other bindings dealing with GPIOs is that it works with GPIO subsystem on the board on which openHAB runs and doesn't require third-party programs/daemons running. The binding consists of two components: base module (org.openhab.io.gpio) which implements low-level GPIO access and provides API for high-level modules (can be used by other bindings needing to interact directly with GPIOs) and the binding itself (org.openhab.binding.gpio) which introduces hardware GPIO pins as full-featured openHAB items capable of generating events or receiving commands depending of their type (input or output)." +oh1,gc100ir,Global Cache IR,"This page describes the Global Cache IR binding (1.x), which allows openHAB items to send commands to the corresponding IR devices from one or more instances of Global Cache." +oh1,gpio,GPIO,"This binding is for the local GPIO subsystem. It is currently only exposed to user space by [Linux GPIO framework](https://www.kernel.org/doc/Documentation/gpio/sysfs.txt). Being based on a kernel implementation, it's hardware agnostic and works on different boards without modification (this is on theory only, not all existing boards can be tested)." oh1,harmonyhub,Harmony Hub,"The Harmony Hub binding is used to enable communication between openHAB and one or more 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." oh1,hdanywhere,HDanywhere,"[HDanywhere](http://www.hdanywhere.co.uk) is a manufacturer of multiroom/distributed audio/video equipment. This binding supports their V3 of the Multiroom+ HDMI matrix running firmware V1.2(20131222). These matrices support the highest HD resolutions, including 1080p 3D & 4K, use a single Cat5e/6/7 wiring structure with reliable performance up to 100m, have IR passback to allow you to select and control what you watch from every room and are fully compatible with universal remote controls." oh1,heatmiser,Heatmiser,"The Heatmiser binding allows you to control Heatmiser RS-422 network thermostats (also sold under other names). The binding communicates via TCP/IP to an RS-422 adaptor that links to the thermostats." oh1,hms,HMS,"This binding enables support of receiving HMS messages via the CUL transport." -oh1,homematic,Homematic,"- RF and WIRED devices are supported" +oh1,homematic,Homematic,"This is the binding for the [eQ-3 Homematic Solution](http://www.eq-3.de/)." oh1,horizon,Horizon mediabox,"This binding supports the horizon mediabox used by cable companies in the Netherlands and some other countries. The box is manufactured by Samsung and known as SMT-G7400 and SMT-G7401. This binding is tested with the SMT-G7401 but should also work with the SMT-G7400. The binding only works when your box is connected to your home network. When you are able to use the HorizonGo remote control app, you should also be able to use this binding." oh1,http,HTTP,"If you want to have openHAB request a URL when commands are sent to items, or have it poll a given URL frequently and update items' states, install and configure this binding." -oh1,hue,Hue,"Click the image below for a YouTube video demonstrating setup, configuration and a simple custom scene controller (openHAB 1, but still relevant to usage on openHAB 2)." +oh1,hue,Hue,"This binding connects openHAB to your Philips Hue lighting system." oh1,iec6205621meter,IEC 62056-21 Meter,"This binding is used to communicate to metering devices supporting serial communication according IEC 62056-21 mode C master. It can be used to read metering data from slaves such as gas, water, heat, or electricity meters." oh1,ihc,IHC / ELKO,"This binding is for the 'Intelligent Home Control' building automation system originally made by LK, but now owned by Schneider Electric and sold as 'IHC Intelligent Home Control'. It is based on a star-configured topology with wires to each device. The system is made up of a central controller and up to 8 input modules and 16 output modules. Each input module can have 16 digital inputs and each output module 8 digital outputs, resulting in a total of 128 input and 128 outputs per controller." oh1,insteonhub,Insteon Hub,"DO NOT USE THIS BINDING. The InsteonHub binding is outdated and no longer supported. Use the InsteonPLM binding instead." @@ -62,17 +62,17 @@ oh1,irtrans,IRTrans,"This binding communicates with the [IRTrans](http://www.irt oh1,jointspace,jointSPACE,"The jointSPACE binding lets you control your Philips TV that is compatible with the [jointSPACE JSON API](http://jointspace.sourceforge.net/projectdata/documentation/jasonApi/index.html) over Ethernet." oh1,k8055,Velleman k8055 USB IO Board,"This binding allows you to integrate a [Velleman k8055 USB IO Board](http://www.vellemanusa.com/products/view/?country=us&lang=enu&id=500349) with openHAB." oh1,km200,KM200,"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." -oh1,knx,KNX (1.x),"The openHAB KNX binding allows one 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." +oh1,knx,KNX,"The openHAB KNX binding allows one 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." oh1,koubachi,Koubachi,"The [Koubachi](http://www.koubachi.com) Services help everybody without a green thumb to be a perfect gardener. All plants can be registered on their really nice website (or through iPhone/iPad App) to tell you when and how to care for your plants. Furthermore they offer a dedicated hardware, the WIFI Plant Sensor. This wireless device measures vital parameters and determines the vitality of your plants." -oh1,lcn,LCN,"![](http://3.bp.blogspot.com/-d5mm3HC7uic/VpO2ctrfWNI/AAAAAAAAJOI/a37JMGhC4IY/s600/openhab_lcn.jpg)" -oh1,lgtv,LG TV,"* Every LG TV Model with Netcast 3.0 and Netcast 4.0 (Model years 2012 & 2013)" +oh1,lcn,LCN,"This binding connects to one or more LCN-PCHK instances via TCP/IP. **This means 1 unused LCN-PCHK license is required!**" +oh1,lgtv,LG TV,"This binding supports LG TV models with Netcast 3.0 and Netcast 4.0 (Model years 2012 & 2013), and with LG TVs which support the UDAP 2.0 protocol over Ethernet. See ['UDAP Specifications (For Second Screen TV and Companion Apps)'](http://developer.lgappstv.com/TV_HELP/topic/lge.tvsdk.references.book/html/UDAP/UDAP/UDAP%20Specifications%20For%20Second%20Screen%20TV%20and%20Companion%20Apps.htm)." oh1,lightwaverf,LightwaveRF,"This binding supports the LightwaveRF products using the LightwaveRF Wifi Link that is available as part of that range." oh1,mailcontrol,MailControl,"This binding provides possibility to receive commands sent via email in JSON format." oh1,maxcube,MAX!Cube,"The MAX!Cube binding allows openHAB to connect to [(ELV) MAX!Cube Lan Gateway](http://www.elv.de/max-cube-lan-gateway.html) installations. The binding allows openHAB to communicate with the MAX! devices through the MAX!Cube Lan Gateway." oh1,maxcul,MAX!CUL,"The aim of this binding is to allow the connection from openHAB to MAX! devices (wall thermostat/radiator valves) using the [CUL USB dongle](http://busware.de/tiki-index.php?page=CUL) rather than the MAX!Cube. This should allow greater control over the devices than the cube offers as all interaction is handled manually." oh1,mcp23017,MCP23017,"This binding provides native access for MCP23017 16 bit bidirectional I/O expander on I2C bus. Please consider datasheet for IC for future information." oh1,mcp3424,MCP3424,"This binding provides native access for MCP3424 18-bit delta sigma ADC on I2C bus. Please consider datasheet for IC for future information. The binding should work with MCP3422 and MCP3423 also, but was not tested due to lack of hardware." -oh1,milight,Milight (1.x),"[![openHAB Milight](http://img.youtube.com/vi/zNe9AkQbfmc/0.jpg)](http://www.youtube.com/watch?v=zNe9AkQbfmc)" +oh1,milight,Milight,"The Milight binding allows openHAB to send commands to multiple Milight bridges." oh1,mios,MiOS Bridge,"This binding exposes read, and read-command, access to Devices controlled by a MiOS Home Automation controller, such as those seen at http://getvera.com." oh1,mochadx10,Mochad X10,"This binding makes it possible to control X10 devices via a server running the [Mochad X10 daemon by mmauka](http://sourceforge.net/projects/mochad/). Mochad is a Linux TCP gateway daemon for the X10 CM15A RF (radio frequency) and PL (power line) controller and the CM19A RF controller." oh1,modbus,Modbus,"The binding supports both TCP and Serial slaves. RTU, ASCII and BIN variants of Serial Modbus are supported." @@ -113,11 +113,11 @@ oh1,pulseaudio,Pulseaudio,"This binding allows openHAB to monitor and control pu oh1,rfxcom,RFXCOM,"The binding should be compatible at least with RFXtrx433 USB 433.92MHz transceiver, which contains both receiver and transmitter functions. The RFXtrx433E is fully compatible with the RFXtrx433, and has in addition the possibility to transmit RFY (Somfy RTS) RF command at the frequency used by Somfy." oh1,rpircswitch,Raspberry Pi RC Switch,"This binding enables the management of remote controlled (RC) switches via a 433-MHz transmitter connected to a Raspberry Pi. It can be used with a 433-MHz transmitter connected to a Raspberry Pi as described in [this assembly instruction](https://www.raspberrypi.org/forums/viewtopic.php?f=37&t=66946)." oh1,rwesmarthome,RWE SmartHome,"This binding allows openHAB to be integrated [RWE SmartHome](https://www.rwe-smarthome.de/) software previous to version 2.0. It uses an unofficial interface, which is limited in some cases, as explained below. As the interface has some delay and polling is needed to receive all changes from the RWE SmartHome Central (SHC), it may take one or two seconds until a device finally responds. However, this is tolerable in most cases as time critical rules can be done in the RWE Smarthome Central itself." -oh1,sagercaster,Sager Weathercaster,"The Sager Weathercaster is a scientific instrument for accurate prediction of the weather." -oh1,sallegra,Sallegra,"The Sallegra binding supports the following devices:" +oh1,sagercaster,Sager Weathercaster,"The Sager Weathercaster is a scientific instrument for accurate prediction of the weather. **This binding is currently incompatible with openHAB 2.**" +oh1,sallegra,Sallegra,"The Sallegra binding supports the Sallegra Dimmer DA-ET-4, Sallegra Relay R-ET-4 and Sallegra Input ADI-ET-8/8." oh1,samsungac,Samsung Air Conditioner,"This binding should be compatible with Samsung Smart Air Conditioner models." oh1,samsungtv,Samsung TV,"This binding should be compatible with Samsung TV models which support Apple and Android remote applications." -oh1,sapp,Sapp,"The default OpenHAB code formatter has been modified in this binding just in the 'maximum line width' parameter, allowing longer lines then the standard OpenHAB." +oh1,sapp,Picnet Sapp,"The openHAB Sapp binding connects to [Picnet](http://www.sinthesi.com) Home Automation installations. The binding supports multi master configuration as well." oh1,satel,Satel Integra Alarm System,"The Satel Integra Alarm System allows openHAB to connect to your alarm system via TCP/IP network with ETHM-1 module installed, or via RS-232 serial port with INT-RS module installed." oh1,serial,Serial,"The Serial binding allows openHAB to communicate in ASCII over serial ports attached to the openHAB server." oh1,smarthomatic,Smarthomatic,"The [Smarthomatic](https://www.smarthomatic.org) binding will connect a network of Smarthomatic devices to your openHAB server." @@ -125,18 +125,18 @@ oh1,snmp,SNMP,"The SNMP binding allows SNMP GET (polling) and SNMP SET (commandi oh1,sonance,Sonance,"This binding integrates with [Sonance DSP Amplifiers](http://www.sonance.com/electronics/amplifiers/dsp). It supports all three models (DSP 2-150, DSP 8-130 and DSP 2-750) but for now it's only tested with the DSP 8-130. For each group you can enable or disable sound (toggle mute) or set the volume." oh1,sonos,Sonos,"**Note:** The Sonos binding communicates with the Sonos devices through the UPnP (Universal Plug And Play) protocol. Users of this binding might wish to familiarise them with the protocol and slang. UPnP defines a subscription model whereby a UPnP client can subscribe to UPnP Events that are transmitted by a UPnP device. Sonos Players do emit quite a bit of Events and some are used to capture status variables (see below)." oh1,souliss,Souliss,"[Souliss](http://www.souliss.net/) is a networking framework for Arduino and compatibles boards, and is designed to let you easily build a smart home that is distributed over multiple boards via Ethernet, wireless point-to-point and RS485 bus." -oh1,squeezebox,Squeezebox,"From the [Wikipedia entry](http://en.wikipedia.org/wiki/Squeezebox_%28network_music_player%29):" +oh1,squeezebox,Squeezebox,"This binding integrates the [Logitech Media Server](http://www.mysqueezebox.com) and compatible Squeeze players." oh1,stiebelheatpump,Stiebel Eltron LWZ,"This binding is used to communicate Stiebel Eltron LWZ heat pumps via a serial interface. The binding is inspired by the work of [Monitoring a Stiebel Eltron LWZ](http://robert.penz.name/heat-pump-lwz) which is hosted at [Heatpumpmonitor](https://launchpad.net/heatpumpmonitor) and is written in Python." oh1,swegonventilation,Swegon Ventilation,"This binding is used to get live data from Swegon ventilation systems into items in openHAB. It should be compatible with at least Swegon CASA models." -oh1,systeminfo,System Information,"The System Information binding provides operating system monitoring data, including:" +oh1,systeminfo,System Information,"The System Information binding provides operating system monitoring data, including system memory, swap, CPU, load average, uptime, per-process memory, per-process CPU, file system metrics and network interface metrics." oh1,tacmi,TACmi,"This binding makes use of the CAN over Ethernet feature of the CMI from Technische Alternative. Since I only have the new UVR16x2, it has only been tested with this controller." -oh1,tcp,TCP & UDPs,"The TCP and UDP bindings provide basic support for simple ASCII-based protocols. They send and receive data as ASCII strings. Data sent out is by default padded with a CR/LF. This should be sufficient for many home automation devices that take simple ASCII-based control commands, or that send back text-based status messages." +oh1,tcp,TCP & UDP,"The TCP and UDP bindings provide basic support for simple ASCII-based protocols. They send and receive data as ASCII strings. Data sent out is by default padded with a CR/LF. This should be sufficient for many home automation devices that take simple ASCII-based control commands, or that send back text-based status messages." oh1,tellstick,Tellstick,"This binding is tested against Tellstick DUO, it should also work with a basic Tellstick. It supports RF 433 Mhz protocols like: Nexa, HomeEasy, X10, CoCo (KlikAanKlikUit), Oregon e.o." -oh1,tinkerforge,TinkerForge,"- [Introduction](#introduction)" +oh1,tinkerforge,TinkerForge,"[TinkerForge](http://www.tinkerforge.com) is a system of open source hardware building blocks that allows you to combine sensor and actuator blocks by plug and play. You can create your individual hardware system by choosing the necessary building blocks for your project and combine it with other home automation products." oh1,tivo,TiVo,"This binding works with older TiVo units which support the v1.0 protocol. TiVo units that implement the [newer v1.1 API](http://www.tivo.com/assets/images/abouttivo/resources/downloads/brochures/TiVo_TCP_Network_Remote_Control_Protocol.pdf) will encounter some incompatibility. If you find that button commands (`pause, play, record`) work, but `nowshowing` does not work, you likely have a Tivo that implements the v1.1 protocol." oh1,ucprelayboard,UCProjects.eu Relay Board,"This binding provides support for relay board available from [ucprojects.eu](http://ucprojects.eu) (site in Polish)" oh1,upb,UPB,"The UPB binding is used to enable communication between openHAB and UPB devices. This binding requires the use of a UPB PIM or power-line modem. This binding has only been tested against simple automated devices." -oh1,urtsi,Somfy URTSI II (1.x),"This binding communicates with Somfy URTSI II devices over a serial connection." +oh1,urtsi,Somfy URTSI II,"This binding communicates with Somfy URTSI II devices over a serial connection." oh1,vdr,Video Disk Recorder (VDR),"The Video Disk Recorder (VDR) binding allows openHAB to control your own digital satellite receiver and [Video Disk Recorder](http://www.tvdr.de)." oh1,wago,WAGO,"The WAGO Binding provides an interface to Ethernet-enabled Modbus-Controllers from WAGO." oh1,weather,Weather,"The Weather binding collects current and forecast weather data from different providers with a free weather API. You can also display weather data with highly customizable html layouts and icons." @@ -144,7 +144,7 @@ oh1,wemo,Wemo,"This binding integrates the [Belkin WeMo Family](http://www.belki oh1,withings,Withings,"The Withings binding allows openHAB to synchronize data from the official Withings API to items. The following body measure types are supported: diastolic blood pressure, fat free mass, fat mass weight, fat ratio, heart pulse, height, systolic blood pressure, weight." oh1,wol,Wake-on-LAN,"For Windows computers not in a domain, the firewall must be configured properly (allow remote shutdowns) and the DWORD-Regkey `LocalAccountTokenFilterPolicy` in `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System` must be set to 1." oh1,xbmc,XBMC binding (for KODI) (1.x),"This binding allows openHAB items to receive realtime updates about information like player state and running media from one or more instances of KODI (formerly known as XBMC)." -oh1,xpl,xPL,"The xPL Bundle provides two packages :" +oh1,xpl,xPL,"The xPL binding grabs xPL message values in items and sends xPL commands." oh1,yamahareceiver,Yamaha Receiver (1.x),"This binding connects openHAB with various Yamaha Receivers." oh1,zibase,Zibase,"Zibase is a French home automation box that supports multiple RF protocols including 433 Mhz (Chacon, Visionic, Oregon...), ZWave, EnOcean, X2D." oh1,zwave,Z-Wave,"The openHAB Z-Wave binding allows you to connect to your Z-Wave wireless mesh network. A Z-Wave network typically consists of one primary controller “stick”, zero or more additional controllers and zero or more Z-Wave enabled devices, e.g. dimmers, switches, sensors etc." @@ -158,9 +158,10 @@ oh2,wemo,Belkin Wemo,"This binding integrates the [Belkin WeMo Family](http://ww oh2,yahooweather,YahooWeather,"This binding uses the [Yahoo Weather service](https://developer.yahoo.com/weather/) for providing current weather information." oh2,allplay,AllPlay,"This binding integrates devices compatible with [Qualcomm AllPlay](https://www.qualcomm.com/products/allplay)." oh2,amazondashbutton,Amazon Dash Button,"The Amazon Dash Button is a very cheap device in order to integrate it in your home automation setup." -oh2,astro,Astro,"The Astro binding is used for calculating many DateTime and positional values for sun and moon." +oh2,astro,Astro,"The Astro binding is used for calculating" oh2,autelis,Autelis Pool Control,"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." oh2,avmfritz,AVM FRITZ!,"The binding integrates the AHA ( [AVM Home Automation](http://avm.de/ratgeber/smart-home/) ) system." +oh2,boschindego,Bosch Indego,"This is the Binding for Bosch Indego Connect lawn mowers." oh2,chromecast,Chromecast,"The binding integrates Google Chromecast streaming devices." oh2,coolmasternet,CoolMasterNet,"The CoolMasterNet binding is used to control [CoolMasterNet HVAC bridge devices](https://coolautomation.com/products/coolmasternet/), using the 'ASCII I/F' plaintext TCP control protocol." oh2,dscalarm,DSC Alarm,"This is an OpenHAB binding for a DSC PowerSeries Alarm System utilizing the EyezOn Envisalink 3/2DS interface or the DSC IT-100 RS-232 interface." @@ -202,6 +203,7 @@ oh2,tesla,Tesla,"This binding integrates the [Tesla Electrical Vehicle](http://w oh2,toon,Toon,"The Toon bindings shows among others current room temperature, setpoint, energy and gas usage information." oh2,urtsi,Somfy URTSI II,"The addressable Universal RTS Interface II (URTSI II) can be used to communicate between home automation or other third party systems and SOMFY’s RTS Motors and controls. It is capable of individual or group control, and can be operated via infrared remote, RS232 and RS485 serial communication. Once an input is activated, an RTS radio command is sent to the automated window treatment." oh2,vitotronic,Vitotronic,"Viessmann heating systems with Vitotronic has a optolink Interface for maintenance." +oh2,wifiled,WiFi LED,"This binding is used to control LED stripes connected by WiFi. These devices are sold with different names, i.e. Magic Home LED, UFO LED, LED NET controller, etc." oh2,yamahareceiver,Yamahareceiver,"This binding connects openHAB with Yamaha Receivers of product line CX-A5000, RX-A30xx, RX-A20xx, RX-A10xx, RX-Vxxx, RX-Z7, DSP-Z7, RX-S600, HTR-xxxx." oh2,zwave,ZWave,"The ZWave binding supports an interface to a wireless Z-Wave home automation network." oh2,zway,Z-Way,"Z-Way is a software to configure and control a Z-Wave network. The software comes with a full stack from Z-Wave transceiver with certified firmware to a REST API on high level." diff --git a/_data/persistence.csv b/_data/persistence.csv index af3045eb7..9f45ed2bf 100644 --- a/_data/persistence.csv +++ b/_data/persistence.csv @@ -7,7 +7,7 @@ oh1,exec,Exec,"This service allows you to execute commands in the underlying OS oh1,influxdb,InfluxDB (0.9 and newer),"This service allows you to persist and query states using the [InfluxDB](http://influxdb.org) time series database. The persisted values can be queried from within openHAB. There also are nice tools on the web for visualizing InfluxDB time series, such as [Grafana](http://grafana.org/)." oh1,influxdb08,InfluxDB (up to 0.8.x),"This service allows you to persist and query states using the [InfluxDB](http://influxdb.org) time series database. The persisted values can be queried from within openHAB. There also are nice tools on the web for visualizing InfluxDB time series, such as [Grafana](http://grafana.org/)." oh1,jdbc,JDBC,"This service writes and reads item states to and from a number of relational database systems that support [Java Database Connectivity (JDBC)](https://en.wikipedia.org/wiki/Java_Database_Connectivity). This service allows you to persist state updates using one of several different underlying database services. It is designed for a maximum of scalability, to store very large amounts of data and still over the years not lose its speed." -oh1,jpa,Java API (JPA),"This service allows you to persist state updates using a SQL or NoSQL database through the [Java Persistence API](https://en.wikipedia.org/wiki/Java_Persistence_API). The service uses an abstraction layer that theoretically allows it to support many available SQL or NoSQL databases." +oh1,jpa,Java Persistence API (JPA),"This service allows you to persist state updates using a SQL or NoSQL database through the [Java Persistence API](https://en.wikipedia.org/wiki/Java_Persistence_API). The service uses an abstraction layer that theoretically allows it to support many available SQL or NoSQL databases." oh1,mapdb,mapdb,"The [mapdb](http://www.mapdb.org/) Persistence Service is based on simple key-value store that only saves the last value. The intention is to use this for `restoreOnStartup` items because all other persistence options have their drawbacks if values are only needed for reload. They:" oh1,mongodb,MongoDB,"This service allows you to persist state updates using the MongoDB database. It supports writing information to a MongoDB document store, as well as querying from it." oh1,mqtt,MQTT,"This service allows you to feed item states to an MQTT broker using the openHAB persistence strategies. The destination broker, topic and messages are configurable." diff --git a/addons/actions/oh1/astro/readme.md b/addons/actions/oh1/astro/readme.md index 3e059669b..a7a028cff 100644 --- a/addons/actions/oh1/astro/readme.md +++ b/addons/actions/oh1/astro/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Astro - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/dscalarm/readme.md b/addons/actions/oh1/dscalarm/readme.md index 92db9c650..ae28506eb 100644 --- a/addons/actions/oh1/dscalarm/readme.md +++ b/addons/actions/oh1/dscalarm/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: DSC Alarm - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/ecobee/readme.md b/addons/actions/oh1/ecobee/readme.md index 8c95e163b..ea2815e53 100644 --- a/addons/actions/oh1/ecobee/readme.md +++ b/addons/actions/oh1/ecobee/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Ecobee - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/harmonyhub/readme.md b/addons/actions/oh1/harmonyhub/readme.md index bbe749536..f48c58c38 100644 --- a/addons/actions/oh1/harmonyhub/readme.md +++ b/addons/actions/oh1/harmonyhub/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Logitech Harmony Hub - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/homematic/readme.md b/addons/actions/oh1/homematic/readme.md index a1106b769..db893c357 100644 --- a/addons/actions/oh1/homematic/readme.md +++ b/addons/actions/oh1/homematic/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Homematic - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/mail/readme.md b/addons/actions/oh1/mail/readme.md index 6ec65a58a..3c86437f5 100644 --- a/addons/actions/oh1/mail/readme.md +++ b/addons/actions/oh1/mail/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Mail - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/mios/readme.md b/addons/actions/oh1/mios/readme.md index ad239ec30..49a3ce284 100644 --- a/addons/actions/oh1/mios/readme.md +++ b/addons/actions/oh1/mios/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: MiOS - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/mqtt/readme.md b/addons/actions/oh1/mqtt/readme.md index 32188fe71..4feb69dee 100644 --- a/addons/actions/oh1/mqtt/readme.md +++ b/addons/actions/oh1/mqtt/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: MQTT - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/nma/readme.md b/addons/actions/oh1/nma/readme.md index 0b26bdf9d..855e79ef6 100644 --- a/addons/actions/oh1/nma/readme.md +++ b/addons/actions/oh1/nma/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: NotifyMyAndroid - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/openwebif/readme.md b/addons/actions/oh1/openwebif/readme.md index 57ed68cfb..2f409f3e4 100644 --- a/addons/actions/oh1/openwebif/readme.md +++ b/addons/actions/oh1/openwebif/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: OpenWebIf - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/pebble/readme.md b/addons/actions/oh1/pebble/readme.md index 0b8f7798e..ac0ffe1ee 100644 --- a/addons/actions/oh1/pebble/readme.md +++ b/addons/actions/oh1/pebble/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Pebble - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/prowl/readme.md b/addons/actions/oh1/prowl/readme.md index 3222e1835..0564292ce 100644 --- a/addons/actions/oh1/prowl/readme.md +++ b/addons/actions/oh1/prowl/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Prowl - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/pushover/readme.md b/addons/actions/oh1/pushover/readme.md index 74ea5a658..6b3edb429 100644 --- a/addons/actions/oh1/pushover/readme.md +++ b/addons/actions/oh1/pushover/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Pushover - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/pushsafer/readme.md b/addons/actions/oh1/pushsafer/readme.md index 20a7e05ac..340665e8d 100644 --- a/addons/actions/oh1/pushsafer/readme.md +++ b/addons/actions/oh1/pushsafer/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Pushsafer - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/satel/readme.md b/addons/actions/oh1/satel/readme.md index 8a3f78ae7..81428df58 100644 --- a/addons/actions/oh1/satel/readme.md +++ b/addons/actions/oh1/satel/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Satel - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/squeezebox/readme.md b/addons/actions/oh1/squeezebox/readme.md index 6364a4669..8b1aa42f4 100644 --- a/addons/actions/oh1/squeezebox/readme.md +++ b/addons/actions/oh1/squeezebox/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Squeezebox - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/telegram/readme.md b/addons/actions/oh1/telegram/readme.md index 2671e9314..10a58bf7a 100644 --- a/addons/actions/oh1/telegram/readme.md +++ b/addons/actions/oh1/telegram/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Telegram - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/tinkerforge/readme.md b/addons/actions/oh1/tinkerforge/readme.md index d3f69fa25..9006e84dc 100644 --- a/addons/actions/oh1/tinkerforge/readme.md +++ b/addons/actions/oh1/tinkerforge/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: TinkerForge - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/twitter/readme.md b/addons/actions/oh1/twitter/readme.md index 5ca471570..7273a1e16 100644 --- a/addons/actions/oh1/twitter/readme.md +++ b/addons/actions/oh1/twitter/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Twitter - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/weather/readme.md b/addons/actions/oh1/weather/readme.md index ab283d811..50a362069 100644 --- a/addons/actions/oh1/weather/readme.md +++ b/addons/actions/oh1/weather/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Weather - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/xbmc/readme.md b/addons/actions/oh1/xbmc/readme.md index 209cf2d2f..34c7ff93a 100644 --- a/addons/actions/oh1/xbmc/readme.md +++ b/addons/actions/oh1/xbmc/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: XBMC - Actions +source: external --- + {% include base.html %} diff --git a/addons/actions/oh1/xmpp/readme.md b/addons/actions/oh1/xmpp/readme.md index ae526ec43..6c18a5054 100644 --- a/addons/actions/oh1/xmpp/readme.md +++ b/addons/actions/oh1/xmpp/readme.md @@ -1,11 +1,16 @@ --- layout: documentation +title: XMPP - Actions +source: external --- + {% include base.html %} # XMPP Actions +This set of actions allows you to send a message to an XMPP user or multi-user chat, or send a message with an attachment to an XMPP user. + ## Actions * `sendXMPP(String to, String message)`: Sends a message to an XMPP user @@ -33,9 +38,7 @@ The XMPP Action service can be configured in `services/xmpp.cfg`. Note: openHAB does not resolve SRV entries like other XMPP clients do, you have to setup the server details manually. Generally, if `joe@example.org` is your XMPP user ID and `xmpp.example.net` points to the server running the service, set `servername` to the actual server `xmpp.example.net`, the user name `username` to `joe` and `proxy` to the domain name part of your user ID `example.org`. - -### Configuration Example: Google - +## Example: Google ``` servername=talk.google.com diff --git a/addons/actions/oh1/xpl/readme.md b/addons/actions/oh1/xpl/readme.md index 527349f00..2dd544d60 100644 --- a/addons/actions/oh1/xpl/readme.md +++ b/addons/actions/oh1/xpl/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: xPL - Actions +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/akm868/readme.md b/addons/bindings/oh1/akm868/readme.md index eb0550a00..9271b88da 100644 --- a/addons/bindings/oh1/akm868/readme.md +++ b/addons/bindings/oh1/akm868/readme.md @@ -1,12 +1,17 @@ --- layout: documentation +title: AKM868 - Bindings +source: external --- + {% include base.html %} # AKM868 Binding -This binding is for users coming from the proprietary homeautomation-system "IP-Symcon". If you have bought some hardware from them, you can use this binding to enable your AKM868 presence detection system. The following hardware was used to do presence detection with the AKM-868 controller and a OVO868-tracker for your key-ring: +This binding is for users coming from the proprietary homeautomation-system "IP-Symcon". If you have bought some hardware from them, you can use this binding to enable your AKM868 presence detection system. + +The following hardware was used to do presence detection with the AKM-868 controller and a OVO868-tracker for your key-ring: ![AKM-Module](https://raw.githubusercontent.com/openhab/openhab1-addons/master/bundles/binding/org.openhab.binding.akm868/src/main/resources/AKM868.png) ![LAN-T Module](https://raw.githubusercontent.com/openhab/openhab1-addons/master/bundles/binding/org.openhab.binding.akm868/src/main/resources/LAN-T868.png) diff --git a/addons/bindings/oh1/alarmdecoder/readme.md b/addons/bindings/oh1/alarmdecoder/readme.md index 0cde642d2..d7c1ba1c6 100644 --- a/addons/bindings/oh1/alarmdecoder/readme.md +++ b/addons/bindings/oh1/alarmdecoder/readme.md @@ -1,13 +1,15 @@ --- layout: documentation +title: Alarm Decoder - Bindings +source: external --- + {% include base.html %} # Alarm Decoder Binding -The [Alarm Decoder](http://www.alarmdecoder.com) is a hardware adapter that interfaces with Ademco/Honeywell alarm panels. It acts -essentially like a keypad, reading and writing messages on a serial bus that connects keypads with the main panel. +The [Alarm Decoder](http://www.alarmdecoder.com) is a hardware adapter that interfaces with Ademco/Honeywell alarm panels. It acts essentially like a keypad, reading and writing messages on a serial bus that connects keypads with the main panel. There are several versions of the adapter available: diff --git a/addons/bindings/oh1/anel/readme.md b/addons/bindings/oh1/anel/readme.md index 3c69b9c69..54b6d15d9 100644 --- a/addons/bindings/oh1/anel/readme.md +++ b/addons/bindings/oh1/anel/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Anel binding - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/asterisk/readme.md b/addons/bindings/oh1/asterisk/readme.md index efdca5232..2dbf3285e 100644 --- a/addons/bindings/oh1/asterisk/readme.md +++ b/addons/bindings/oh1/asterisk/readme.md @@ -1,12 +1,15 @@ --- layout: documentation +title: Asterisk - Bindings +source: external --- + {% include base.html %} # Asterisk Binding -The Asterisk binding is used to enable communication between openhab and the free and open source PBX solution [Asterisk](http://www.asterisk.org). By help of this binding, you can e.g. detect incoming phone calls or determine if someone currently does a phone call. In combination with other bindings (e.g. the Samsung TV Binding) you can display caller IDs on your TV. +The Asterisk binding is used to enable communication between openhab and the free and open source PBX solution [Asterisk](http://www.asterisk.org). This binding detects incoming phone calls or if someone makes a phone call. In combination with other bindings (e.g., the Samsung TV Binding) you can display caller IDs on your TV. ## Binding Configuration diff --git a/addons/bindings/oh1/astro/readme.md b/addons/bindings/oh1/astro/readme.md index d65b44564..348788a89 100644 --- a/addons/bindings/oh1/astro/readme.md +++ b/addons/bindings/oh1/astro/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Astro - Bindings +source: external --- + {% include base.html %} @@ -8,7 +11,7 @@ layout: documentation The Astro binding is used for calculating many `DateTime` and positional values for sun and moon and for scheduling of events. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/astro/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/astro/readme.html). ### Binding Configuration diff --git a/addons/bindings/oh1/autelis/readme.md b/addons/bindings/oh1/autelis/readme.md index 51ac99a8f..5a53a1c83 100644 --- a/addons/bindings/oh1/autelis/readme.md +++ b/addons/bindings/oh1/autelis/readme.md @@ -1,19 +1,22 @@ --- layout: documentation +title: Autelis - Bindings +source: external --- + {% include base.html %} # Autelis 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](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. The binding is fairly complete and supports the following functionality. * Read circuit, auxiliary, temperature, pump, chemistry and system values * Control circuit, auxiliary lighting scenes, and temperature set points -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/autelis/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/autelis/readme.html). ## Binding Configuration diff --git a/addons/bindings/oh1/benqprojector/readme.md b/addons/bindings/oh1/benqprojector/readme.md index 266003f6c..4fa76be39 100644 --- a/addons/bindings/oh1/benqprojector/readme.md +++ b/addons/bindings/oh1/benqprojector/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: BenQ Projector - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/bluetooth/readme.md b/addons/bindings/oh1/bluetooth/readme.md index 57e69e9aa..84b6309c5 100644 --- a/addons/bindings/oh1/bluetooth/readme.md +++ b/addons/bindings/oh1/bluetooth/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Bluetooth - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/bticino/readme.md b/addons/bindings/oh1/bticino/readme.md index e6146370b..9e52d37aa 100644 --- a/addons/bindings/oh1/bticino/readme.md +++ b/addons/bindings/oh1/bticino/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Bticino - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/caldav-command/readme.md b/addons/bindings/oh1/caldav-command/readme.md index 5e4413683..f45e4b42e 100644 --- a/addons/bindings/oh1/caldav-command/readme.md +++ b/addons/bindings/oh1/caldav-command/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: CalDAV Command - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/caldav-personal/readme.md b/addons/bindings/oh1/caldav-personal/readme.md index 0599cbfb6..ba7f81e64 100644 --- a/addons/bindings/oh1/caldav-personal/readme.md +++ b/addons/bindings/oh1/caldav-personal/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: CalDAV Personal - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/comfoair/readme.md b/addons/bindings/oh1/comfoair/readme.md index 7f2f96dbc..190e7f74e 100644 --- a/addons/bindings/oh1/comfoair/readme.md +++ b/addons/bindings/oh1/comfoair/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: ComfoAir - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/configadmin/readme.md b/addons/bindings/oh1/configadmin/readme.md index ead58b540..b21ddaf55 100644 --- a/addons/bindings/oh1/configadmin/readme.md +++ b/addons/bindings/oh1/configadmin/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: ConfigAdmin - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/cups/readme.md b/addons/bindings/oh1/cups/readme.md index 26f26a9d6..e0822623d 100644 --- a/addons/bindings/oh1/cups/readme.md +++ b/addons/bindings/oh1/cups/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: CUPS - Bindings +source: external --- + {% include base.html %} @@ -8,7 +11,7 @@ layout: documentation The openHAB CUPS binding allows interaction with printers and their print queues via a CUPS server. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/ipp/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/ipp/readme.html). ## Prerequisites diff --git a/addons/bindings/oh1/daikin/readme.md b/addons/bindings/oh1/daikin/readme.md index 668c4057b..95a6a355c 100644 --- a/addons/bindings/oh1/daikin/readme.md +++ b/addons/bindings/oh1/daikin/readme.md @@ -1,14 +1,15 @@ --- layout: documentation +title: Daikin - Bindings +source: external --- + {% include base.html %} # Daikin Binding -The openHAB Daikin binding allows monitoring and control of a Daikin air -conditioner/heat pump. - +The Daikin binding allows monitoring and control of a Daikin air conditioner or heat pump, through either the KKRP01A wired module or the BRP072A42 wireless module. ## Prerequisites @@ -35,7 +36,7 @@ Multiple KKRP01A units can be configured by giving each a unique name. | Property | Default | Required | Description | |--------------------|---------|:--------:|----------------------------------------------| -| ``.host | | Yes | `` is a unique name for the Daikin unit, also used in item bindings.
The value of this setting must be formatted as ``@`
`.
`` refers to the Daikin Remote Control Device, and must be either WIRELESS or WIRED.
`
` is the IP address or hostname of the Daikin unit. | +| ``.host | | Yes | `` is a unique name for the Daikin unit, also used in item bindings.
The value of this setting must be formatted as ``@`
`.
`` refers to the Daikin Remote Control Device, and must be either WIRELESS or WIRED.
`
` is the IP address or hostname of the Daikin unit. | | refresh | 60000 | No | The refresh interval (in milliseconds) | diff --git a/addons/bindings/oh1/davis/readme.md b/addons/bindings/oh1/davis/readme.md index df1401606..38a813126 100644 --- a/addons/bindings/oh1/davis/readme.md +++ b/addons/bindings/oh1/davis/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Davis - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/ddwrt/readme.md b/addons/bindings/oh1/ddwrt/readme.md index bc920917b..4e8548dc7 100644 --- a/addons/bindings/oh1/ddwrt/readme.md +++ b/addons/bindings/oh1/ddwrt/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: DD-WRT - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/denon/readme.md b/addons/bindings/oh1/denon/readme.md index a09ca4cf5..5a418a2ad 100644 --- a/addons/bindings/oh1/denon/readme.md +++ b/addons/bindings/oh1/denon/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Denon - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/digitalstrom/readme.md b/addons/bindings/oh1/digitalstrom/readme.md index dbc6563e5..39fe47e47 100644 --- a/addons/bindings/oh1/digitalstrom/readme.md +++ b/addons/bindings/oh1/digitalstrom/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: digitalSTROM - Bindings +source: external --- + {% include base.html %} @@ -18,7 +21,7 @@ The openHAB digitalSTROM binding allows interaction with digitalSTROM devices. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/digitalstrom/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/digitalstrom/readme.html). ## Prerequisites diff --git a/addons/bindings/oh1/diyonxbee/readme.md b/addons/bindings/oh1/diyonxbee/readme.md index 46fce2e48..ed67fd414 100644 --- a/addons/bindings/oh1/diyonxbee/readme.md +++ b/addons/bindings/oh1/diyonxbee/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: DIYOnXBee - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/dmx/readme.md b/addons/bindings/oh1/dmx/readme.md index 49067b857..843946a93 100644 --- a/addons/bindings/oh1/dmx/readme.md +++ b/addons/bindings/oh1/dmx/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: DMX - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/dscalarm/readme.md b/addons/bindings/oh1/dscalarm/readme.md index 9fe15412d..4125d90f1 100644 --- a/addons/bindings/oh1/dscalarm/readme.md +++ b/addons/bindings/oh1/dscalarm/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: DSC PowerSeries Alarm System - Bindings +source: external --- + {% include base.html %} @@ -16,7 +19,7 @@ The openHAB DSC Alarm binding provides connectivity to the DSC Alarm panel via a Additionally there is a DSC Alarm action bundle that can be installed along with the DSC Alarm binding. The action provides the ability to send DSC Alarm commands directly to the DSC Alarm system using rules. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/dscalarm/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/dscalarm/readme.html). ## Binding Configuration diff --git a/addons/bindings/oh1/dsmr/readme.md b/addons/bindings/oh1/dsmr/readme.md index fba5db2d4..9a3ac790e 100644 --- a/addons/bindings/oh1/dsmr/readme.md +++ b/addons/bindings/oh1/dsmr/readme.md @@ -1,21 +1,19 @@ --- layout: documentation +title: DSMR - Bindings +source: external --- + {% include base.html %} # DSMR Binding -The openHAB DSMR binding is targeted for Dutch users having a smart meter -('Slimme meter' in Dutch). Data of Dutch smart meters can be obtained via the -P1-port. When connecting this port from a serial port the data can be read out. +The openHAB DSMR binding is targeted for Dutch users having a smart meter ('Slimme meter' in Dutch). Data of Dutch smart meters can be obtained via the P1-port. When connecting this port from a serial port the data can be read out. -This binding reads the P1-port of the Dutch Smart Meters that comply to -NTA8130, DSMR v2.1, DSMR v2.2, DSMR v3.0, DSMR v4.0 or DSMR v4.04. - -Users not living in the Netherlands that want to read a meter should review the -[IEC-62056-21 Meter Binding](https://github.com/openhab/openhab/wiki/IEC-62056---21-Meter-Binding). +This binding reads the P1-port of the Dutch Smart Meters that comply to NTA8130, DSMR v2.1, DSMR v2.2, DSMR v3.0, DSMR v4.0 or DSMR v4.04. +Users not living in the Netherlands that want to read a meter should review the [IEC-62056-21 Meter Binding](https://github.com/openhab/openhab/wiki/IEC-62056---21-Meter-Binding). ## Binding Configuration diff --git a/addons/bindings/oh1/ebus/readme.md b/addons/bindings/oh1/ebus/readme.md index 197a17115..eb31f7b67 100644 --- a/addons/bindings/oh1/ebus/readme.md +++ b/addons/bindings/oh1/ebus/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: eBUS - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/ecobee/readme.md b/addons/bindings/oh1/ecobee/readme.md index 4e448ea11..88538ab07 100644 --- a/addons/bindings/oh1/ecobee/readme.md +++ b/addons/bindings/oh1/ecobee/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Ecobee - Bindings +source: external --- + {% include base.html %} @@ -8,6 +11,29 @@ layout: documentation Ecobee Inc. of Toronto, Canada, sells a range of Wi-Fi enabled thermostats, principally in the Americas. The EMS, EMS Si, Smart, Smart Si and ecobee3 models are supported by this binding, which communicates with the [Ecobee API](https://www.ecobee.com/home/developer/api/documentation/v1/index.shtml) over a secure, RESTful API to Ecobee's servers. Monitoring ambient temperature and humidity, changing HVAC mode, changing heat or cool setpoints, changing the backlight intensity, and even sending textual messages to one or a group of thermostats, can be accomplished through this binding. + +## Table of Contents + + + +- [Prerequisites](#prerequisites) +- [Binding Configuration](#binding-configuration) + - [Example ecobee.cfg](#example-ecobeecfg) + - [Multiple Connections](#multiple-connections) +- [Item Configuration](#item-configuration) + - [ecobee3 Remote Sensors](#ecobee3-remote-sensors) +- [Authorization](#authorization) + - [Troubleshooting Authorization](#troubleshooting-authorization) +- [Example Item Configurations](#example-item-configurations) +- [Examples](#examples) + - [Item Examples](#item-examples) + - [Basic configuration](#basic-configuration) + - [Tracking last occupancy](#tracking-last-occupancy) + - [MAP Transformations](#map-transformations) +- [Notes](#notes) + + + ## Prerequisites In order to use this binding, you must have already registered your thermostat(s) with Ecobee, registered a new app as a [developer](https://www.ecobee.com/developers/), and then login to your [web portal](https://www.ecobee.com/). @@ -27,7 +53,7 @@ This binding can be configured in the file `services/ecobee.cfg`. | timeout | 20000 | No | Time in milliseconds to allow an API request to complete | | tempscale | F | No | temperature scale to use when sending or receiving temperatures. Can be `C` or `F` | -### Example +### Example ecobee.cfg ``` # the private API key issued be Ecobee to use the API (required, replace with your own) @@ -80,10 +106,7 @@ The first character is then followed by a section between square brackets (`[` a Where `` is a decimal thermostat identifier for in (`<`), out (`>`) and bidirectional (`=`) bindings. > *Where can I find my thermostat identifier?* -> A thermostat identifier is a long, decimal number. For ecobee3 users, one way to find the number is to login to your Ecobee portal and read the URL you were taken to in the browser's address bar: ->``` -https://www.ecobee.com/consumerportal/index.html#/thermostats/318973256526 -``` +> A thermostat identifier is a long, decimal number. For ecobee3 users, one way to find the number is to login to your Ecobee portal and read the URL you were taken to in the browser's address bar: `https://www.ecobee.com/consumerportal/index.html#/thermostats/318973256526` > The final component of the URL is your thermostat identifier. > For non-ecobee3 users who are using the older web portal, you can go to the Home IQ™ tab and choose Download Data from the Report chart. The thermostat identifier can be found in the report. @@ -91,7 +114,7 @@ For out (`>`) bindings only, `` can instead be selection criteria th In the case of out bindings for EMS or Utility accounts, the `` criteria can be a path to a management set (for example, `/Toronto/Campus/BuildingA`). Please note that management set path elements that contain the `.` or `#` characters cannot be specified. -The `` specification can be optionally prepended with a specific "user ID" as specified in openhab.cfg, as in `condo.123456789` when you have specified `ecobee:condo.scope` and `ecobee:condo.appkey` properties in openhab.cfg. +The `` specification can be optionally prepended with a specific "user ID" as specified in the binding configuration, as in `condo.123456789` when you have specified `condo.scope` and `condo.appkey` binding configuration properties. `` is one of a long list of thermostat properties than you can read and optionally change. See the list below, and peruse this binding's JavaDoc for all specifics as to their meanings. @@ -102,12 +125,14 @@ runtime.actualTemperature | X | | DecimalType runtime.actualHumidity | X | | DecimalType settings.hvacMode | X | X | StringType +Please see a complete list [below](#examples). + ### ecobee3 Remote Sensors If you have an ecobee3 thermostat with remote, wireless temperature/occupancy sensors, the binding can read their values. Format: ``` -... { ecobee="<[#remoteSensors().capability().value]" } +ecobee="<[#remoteSensors().capability().value]" ``` Supply the long, decimal thermostat ID as in other in-binding configurations. The binding configuration string uses the simple name you gave the remote sensor for ``. The characters `(`,`)`,`[`,`]`, and `.` are not permitted in sensor names when used with the binding. @@ -117,16 +142,16 @@ The ecobee3 sensors are known to report temperature or occupancy, and so you wou > Note that `occupancy` is computed (by Ecobee, not the binding) to mean presence within the last 30 minutes, not current occupancy. ``` -Number KitchenTemp "Kitchen temperature [%.1f °F]" { ecobee="<[123456789#remoteSensors(Kitchen).capability(temperature).value]" } +Number KitchenTemp "Kitchen temperature [%.1f °F]" { ecobee="<[123456789#remoteSensors(Kitchen).capability(temperature).value]" } Number BasementTemp "Basement temperature [%.1f °F]" { ecobee="<[123456789#remoteSensors(Basement).capability(temperature).value]" } -Switch BedroomOccu "Bedroom occupancy [%s]" { ecobee="<[123456789#remoteSensors(Bedroom).capability(occupancy).value]" } +Switch BedroomOccu "Bedroom occupancy [%s]" { ecobee="<[123456789#remoteSensors(Bedroom).capability(occupancy).value]" } ``` See the Example Binding Strings section below for more examples. ## Authorization -After you have installed the binding JAR in your `addons` directory, configured your `openhab.cfg` file, added items to your .items file and started OpenHAB (if not previously started), when the binding performs its first poll, it will discover that is has not yet been authorized by the Ecobee servers, and will retrieve a four-character PIN from the Ecobee server. This PIN will appear prominently in your `openhab.log` file (See [Logging](#Logging) for setup): +After you have installed and configured the binding, added items to your `.items file` and started openHAB (if not previously started), when the binding performs its first poll, it will discover that is has not yet been authorized by the Ecobee servers, and will retrieve a four-character PIN from the Ecobee server. This PIN will appear prominently in your `openhab.log` file: ######################################################################################### # Ecobee-Integration: U S E R I N T E R A C T I O N R E Q U I R E D !! @@ -138,7 +163,11 @@ After you have installed the binding JAR in your `addons` directory, configured When it does, enter it into your Apps settings in your account at ecobee.com. This will authorize your instance of the binding to work with your Ecobee account. On the next poll of the API, it will retrieve access and refresh tokens and continue. ### Troubleshooting Authorization -If you happen to miss the window the ecobee.com website will still accept the PIN but OpenHAB will be unable to get authorization. If this happens the following may help: + +Setting the binding's logger `org.openhab.binding.ecobee` to DEBUG or TRACE level will help you diagnose any issues. + +If you happen to miss the time window to register your PIN, the ecobee.com website will still accept the PIN but openHAB will be unable to get authorization. If this happens the following may help: + * Stop the openHAB server * Delete the Java Preferences storage where the tokens are kept. * On Linux, this is done by deleting the specific obfuscated directory name under ~/.java/.userPrefs. If you only have one garbled directory name there, you can just rm -rf ~/.java/.userPrefs (so as to not delete something else's storage). @@ -149,333 +178,266 @@ If you happen to miss the window the ecobee.com website will still accept the PI ## Example Item Configurations Return or set the name of the thermostat whose ID is 123456789 using the default -Ecobee app instance (configured in openhab.cfg): +Ecobee app instance (configured in [binding configuration](#binding-configuration)): ``` -{ ecobee="=[123456789#name]" } +ecobee="=[123456789#name]" ``` Return the current temperature read by the thermostat using the condo account at ecobee.com: ``` -{ ecobee="<[condo.987654321#runtime.actualTemperature]" } +ecobee="<[condo.987654321#runtime.actualTemperature]" ``` Return or set the minimum number of minutes per hour the fan will run on thermostat ID 543212345: ``` -{ ecobee="=[543212345#settings.fanMinOnTime]" } +ecobee="=[543212345#settings.fanMinOnTime]" ``` Change the HVAC mode to one of `auto`, `auxHeatOnly`, `cool`, `heat`, or `off` on all thermostats registered in the default app instance: ``` -{ ecobee=">[*#settings.hvacMode]" } +ecobee=">[*#settings.hvacMode]" ``` Changes the backlight sleep intensity on all thermostats at the lake house (meaning, all thermostats registered to the lakehouse Ecobee account): ``` -{ ecobee=">[lakehouse.*#settings.backlightSleepIntensity]" } +ecobee=">[lakehouse.*#settings.backlightSleepIntensity]" ``` Determine if there was any occupancy in the condo's kitchen within the last 30 minutes: ``` -{ ecobee="<[condo.987654321#remoteSensors(Kitchen).capability(occupancy).value]" } +ecobee="<[condo.987654321#remoteSensors(Kitchen).capability(occupancy).value]" ``` ## Examples -Here are some examples of valid binding configuration strings, as you would define in your .items file. Each item binding indicates if it is an in-only binding or bidirectional binding string in the examples below. +### Item Examples - /* Ecobee binding items (replace 123456789012 with your thermostat ID) */ - - String identifier "identifier [%s]" { ecobee="<[123456789012#identifier]" } - String name "name [%s]" { ecobee="=[123456789012#name]" } - String thermostatRev "thermostatRev [%s]" { ecobee="<[123456789012#thermostatRev]" } - String isRegistered "isRegistered [%s]" { ecobee="<[123456789012#isRegistered]" } - String modelNumber "modelNumber [%s]" { ecobee="<[123456789012#modelNumber]" } - String brand "brand [%s]" { ecobee="<[123456789012#brand]" } // as of openHAB 1.8 - String features "features [%s]" { ecobee="<[123456789012#features]" } // as of openHAB 1.8 - DateTime lastModified "lastModified [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" { ecobee="<[123456789012#lastModified]" } - DateTime thermostatTime "thermostatTime [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" { ecobee="<[123456789012#thermostatTime]" } - DateTime utcTime "utcTime [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" { ecobee="<[123456789012#utcTime]" } - String equipmentStatus "equipmentStatus [%s]" { ecobee="<[123456789012#equipmentStatus]" } - String version_thermostatFirmwareVersion "thermostatFirmwareVersion [%s]" { ecobee="<[123456789012#version.thermostatFirmwareVersion]" } - String program_currentClimateRef "currentClimateRef [%s]" { ecobee="<[123456789012#program.currentClimateRef]" } - - Group All - Group gSettings (All) - - String settings_hvacMode "hvacMode [%s]" (gSettings) { ecobee="=[123456789012#settings.hvacMode]" } - String settings_lastServiceDate "lastServiceDate [%s]" (gSettings) { ecobee="=[123456789012#settings.lastServiceDate]" } - Switch settings_serviceRemindMe "serviceRemindMe [%s]" (gSettings) { ecobee="=[123456789012#settings.serviceRemindMe]" } - Number settings_monthsBetweenService "monthsBetweenService [%d]" (gSettings) { ecobee="=[123456789012#settings.monthsBetweenService]" } - String settings_remindMeDate "remindMeDate [%s]" (gSettings) { ecobee="=[123456789012#settings.remindMeDate]" } - String settings_vent "vent [%s]" (gSettings) { ecobee="=[123456789012#settings.vent]" } - Number settings_ventilatorMinOnTime "ventilatorMinOnTime [%d]" (gSettings) { ecobee="=[123456789012#settings.ventilatorMinOnTime]" } - Switch settings_serviceRemindTechnician "serviceRemindTechnician [%s]" (gSettings) { ecobee="=[123456789012#settings.serviceRemindTechnician]" } - String settings_eiLocation "eiLocation [%s]" (gSettings) { ecobee="=[123456789012#settings.eiLocation]" } - Number settings_coldTempAlert "coldTempAlert [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.coldTempAlert]" } - Switch settings_coldTempAlertEnabled "coldTempAlertEnabled [%s]" (gSettings) { ecobee="=[123456789012#settings.coldTempAlertEnabled]" } - Number settings_hotTempAlert "hotTempAlert [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.hotTempAlert]" } - Switch settings_hotTempAlertEnabled "hotTempAlertEnabled [%s]" (gSettings) { ecobee="=[123456789012#settings.hotTempAlertEnabled]" } - Number settings_coolStages "coolStages [%d]" (gSettings) { ecobee="<[123456789012#settings.coolStages]" } - Number settings_heatStages "heatStages [%d]" (gSettings) { ecobee="<[123456789012#settings.heatStages]" } - Number settings_maxSetBack "maxSetBack [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.maxSetBack]" } - Number settings_maxSetForward "maxSetForward [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.maxSetForward]" } - Number settings_quickSaveSetBack "quickSaveSetBack [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.quickSaveSetBack]" } - Number settings_quickSaveSetForward "quickSaveSetForward [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.quickSaveSetForward]" } - Switch settings_hasHeatPump "hasHeatPump [%s]" (gSettings) { ecobee="<[123456789012#settings.hasHeatPump]" } - Switch settings_hasForcedAir "hasForcedAir [%s]" (gSettings) { ecobee="<[123456789012#settings.hasForcedAir]" } - Switch settings_hasBoiler "hasBoiler [%s]" (gSettings) { ecobee="<[123456789012#settings.hasBoiler]" } - Switch settings_hasHumidifier "hasHumidifier [%s]" (gSettings) { ecobee="<[123456789012#settings.hasHumidifier]" } - Switch settings_hasErv "hasErv [%s]" (gSettings) { ecobee="<[123456789012#settings.hasErv]" } - Switch settings_hasHrv "hasHrv [%s]" (gSettings) { ecobee="<[123456789012#settings.hasHrv]" } - Switch settings_condensationAvoid "condensationAvoid [%s]" (gSettings) { ecobee="=[123456789012#settings.condensationAvoid]" } - Switch settings_useCelsius "useCelsius [%s]" (gSettings) { ecobee="=[123456789012#settings.useCelsius]" } - Switch settings_useTimeFormat12 "useTimeFormat12 [%s]" (gSettings) { ecobee="=[123456789012#settings.useTimeFormat12]" } - String settings_locale "locale [%s]" (gSettings) { ecobee="=[123456789012#settings.locale]" } - String settings_humidity "humidity [%s]" (gSettings) { ecobee="=[123456789012#settings.humidity]" } - String settings_humidifierMode "humidifierMode [%s]" (gSettings) { ecobee="=[123456789012#settings.humidifierMode]" } - Number settings_backlightOnIntensity "backlightOnIntensity [%d]" (gSettings) { ecobee="=[123456789012#settings.backlightOnIntensity]" } - Number settings_backlightSleepIntensity "backlightSleepIntensity [%d]" (gSettings) { ecobee="=[123456789012#settings.backlightSleepIntensity]" } - Number settings_backlightOffTime "backlightOffTime [%d]" (gSettings) { ecobee="=[123456789012#settings.backlightOffTime]" } - Number settings_soundTickVolume "soundTickVolume [%d]" (gSettings) { ecobee="=[123456789012#settings.soundTickVolume]" } - Number settings_soundAlertVolume "soundAlertVolume [%d]" (gSettings) { ecobee="=[123456789012#settings.soundAlertVolume]" } - Number settings_compressorProtectionMinTime "compressorProtectionMinTime [%d]" (gSettings) { ecobee="=[123456789012#settings.compressorProtectionMinTime]" } - Number settings_compressorProtectionMinTemp "compressorProtectionMinTemp [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.compressorProtectionMinTemp]" } - Number settings_stage1HeatingDifferentialTemp "stage1HeatingDifferentialTemp [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.stage1HeatingDifferentialTemp]" } - Number settings_stage1CoolingDifferentialTemp "stage1CoolingDifferentialTemp [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.stage1CoolingDifferentialTemp]" } - Number settings_stage1HeatingDissipationTime "stage1HeatingDissipationTime [%d]" (gSettings) { ecobee="=[123456789012#settings.stage1HeatingDissipationTime]" } - Number settings_stage1CoolingDissipationTime "stage1CoolingDissipationTime [%d]" (gSettings) { ecobee="=[123456789012#settings.stage1CoolingDissipationTime]" } - Switch settings_heatPumpReversalOnCool "heatPumpReversalOnCool [%s]" (gSettings) { ecobee="=[123456789012#settings.heatPumpReversalOnCool]" } - Switch settings_fanControlRequired "fanControlRequired [%s]" (gSettings) { ecobee="=[123456789012#settings.fanControlRequired]" } - Number settings_fanMinOnTime "fanMinOnTime [%d]" (gSettings) { ecobee="=[123456789012#settings.fanMinOnTime]" } - Number settings_heatCoolMinDelta "heatCoolMinDelta [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.heatCoolMinDelta]" } - Number settings_tempCorrection "tempCorrection [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.tempCorrection]" } - String settings_holdAction "holdAction [%s]" (gSettings) { ecobee="=[123456789012#settings.holdAction]" } - Switch settings_heatPumpGroundWater "heatPumpGroundWater [%s]" (gSettings) { ecobee="<[123456789012#settings.heatPumpGroundWater]" } - Switch settings_hasElectric "hasElectric [%s]" (gSettings) { ecobee="<[123456789012#settings.hasElectric]" } - Switch settings_hasDehumidifier "hasDehumidifier [%s]" (gSettings) { ecobee="<[123456789012#settings.hasDehumidifier]" } - String settings_dehumidifierMode "dehumidifierMode [%s]" (gSettings) { ecobee="=[123456789012#settings.dehumidifierMode]" } - Number settings_dehumidifierLevel "dehumidifierLevel [%d]" (gSettings) { ecobee="=[123456789012#settings.dehumidifierLevel]" } - Switch settings_dehumidifyWithAC "dehumidifyWithAC [%s]" (gSettings) { ecobee="=[123456789012#settings.dehumidifyWithAC]" } - Number settings_dehumidifyOvercoolOffset "dehumidifyOvercoolOffset [%d]" (gSettings) { ecobee="=[123456789012#settings.dehumidifyOvercoolOffset]" } - Switch settings_autoHeatCoolFeatureEnabled "autoHeatCoolFeatureEnabled [%s]" (gSettings) { ecobee="=[123456789012#settings.autoHeatCoolFeatureEnabled]" } - Switch settings_wifiOfflineAlert "wifiOfflineAlert [%s]" (gSettings) { ecobee="=[123456789012#settings.wifiOfflineAlert]" } - Number settings_heatMinTemp "heatMinTemp [%.1f °F]" (gSettings) { ecobee="<[123456789012#settings.heatMinTemp]" } - Number settings_heatMaxTemp "heatMaxTemp [%.1f °F]" (gSettings) { ecobee="<[123456789012#settings.heatMaxTemp]" } - Number settings_coolMinTemp "coolMinTemp [%.1f °F]" (gSettings) { ecobee="<[123456789012#settings.coolMinTemp]" } - Number settings_coolMaxTemp "coolMaxTemp [%.1f °F]" (gSettings) { ecobee="<[123456789012#settings.coolMaxTemp]" } - Number settings_heatRangeHigh "heatRangeHigh [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.heatRangeHigh]" } - Number settings_heatRangeLow "heatRangeLow [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.heatRangeLow]" } - Number settings_coolRangeHigh "coolRangeHigh [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.coolRangeHigh]" } - Number settings_coolRangeLow "coolRangeLow [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.coolRangeLow]" } - String settings_userAccessCode "userAccessCode [%s]" (gSettings) { ecobee="=[123456789012#settings.userAccessCode]" } - Number settings_userAccessSetting "userAccessSetting [%d]" (gSettings) { ecobee="=[123456789012#settings.userAccessSetting]" } - Number settings_auxRuntimeAlert "auxRuntimeAlert [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.auxRuntimeAlert]" } - Number settings_auxOutdoorTempAlert "auxOutdoorTempAlert [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.auxOutdoorTempAlert]" } - Number settings_auxMaxOutdoorTemp "auxMaxOutdoorTemp [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.auxMaxOutdoorTemp]" } - Switch settings_auxRuntimeAlertNotify "auxRuntimeAlertNotify [%s]" (gSettings) { ecobee="=[123456789012#settings.auxRuntimeAlertNotify]" } - Switch settings_auxOutdoorTempAlertNotify "auxOutdoorTempAlertNotify [%s]" (gSettings) { ecobee="=[123456789012#settings.auxOutdoorTempAlertNotify]" } - Switch settings_auxRuntimeAlertNotifyTechnician "auxRuntimeAlertNotifyTechnician [%s]" (gSettings) { ecobee="=[123456789012#settings.auxRuntimeAlertNotifyTechnician]" } - Switch settings_auxOutdoorTempAlertNotifyTechnician "auxOutdoorTempAlertNotifyTechnician [%s]" (gSettings) { ecobee="=[123456789012#settings.auxOutdoorTempAlertNotifyTechnician]" } - Switch settings_disablePreHeating "disablePreHeating [%s]" (gSettings) { ecobee="=[123456789012#settings.disablePreHeating]" } - Switch settings_disablePreCooling "disablePreCooling [%s]" (gSettings) { ecobee="=[123456789012#settings.disablePreCooling]" } - Switch settings_installerCodeRequired "installerCodeRequired [%s]" (gSettings) { ecobee="=[123456789012#settings.installerCodeRequired]" } - String settings_drAccept "drAccept [%s]" (gSettings) { ecobee="=[123456789012#settings.drAccept]" } - Switch settings_isRentalProperty "isRentalProperty [%s]" (gSettings) { ecobee="=[123456789012#settings.isRentalProperty]" } - Switch settings_useZoneController "useZoneController [%s]" (gSettings) { ecobee="=[123456789012#settings.useZoneController]" } - Number settings_randomStartDelayCool "randomStartDelayCool [%d]" (gSettings) { ecobee="=[123456789012#settings.randomStartDelayCool]" } - Number settings_randomStartDelayHeat "randomStartDelayHeat [%d]" (gSettings) { ecobee="=[123456789012#settings.randomStartDelayHeat]" } - Number settings_humidityHighAlert "humidityHighAlert [%d]" (gSettings) { ecobee="=[123456789012#settings.humidityHighAlert]" } - Number settings_humidityLowAlert "humidityLowAlert [%d]" (gSettings) { ecobee="=[123456789012#settings.humidityLowAlert]" } - Switch settings_disableHeatPumpAlerts "disableHeatPumpAlerts [%s]" (gSettings) { ecobee="=[123456789012#settings.disableHeatPumpAlerts]" } - Switch settings_disableAlertsOnIdt "disableAlertsOnIdt [%s]" (gSettings) { ecobee="=[123456789012#settings.disableAlertsOnIdt]" } - Switch settings_humidityAlertNotify "humidityAlertNotify [%s]" (gSettings) { ecobee="=[123456789012#settings.humidityAlertNotify]" } - Switch settings_humidityAlertNotifyTechnician "humidityAlertNotifyTechnician [%s]" (gSettings) { ecobee="=[123456789012#settings.humidityAlertNotifyTechnician]" } - Switch settings_tempAlertNotify "tempAlertNotify [%s]" (gSettings) { ecobee="=[123456789012#settings.tempAlertNotify]" } - Switch settings_tempAlertNotifyTechnician "tempAlertNotifyTechnician [%s]" (gSettings) { ecobee="=[123456789012#settings.tempAlertNotifyTechnician]" } - Number settings_monthlyElectricityBillLimit "monthlyElectricityBillLimit [%d]" (gSettings) { ecobee="=[123456789012#settings.monthlyElectricityBillLimit]" } - Switch settings_enableElectricityBillAlert "enableElectricityBillAlert [%s]" (gSettings) { ecobee="=[123456789012#settings.enableElectricityBillAlert]" } - Switch settings_enableProjectedElectricityBillAlert "enableProjectedElectricityBillAlert [%s]" (gSettings) { ecobee="=[123456789012#settings.enableProjectedElectricityBillAlert]" } - Number settings_electricityBillingDayOfMonth "electricityBillingDayOfMonth [%d]" (gSettings) { ecobee="=[123456789012#settings.electricityBillingDayOfMonth]" } - Number settings_electricityBillCycleMonths "electricityBillCycleMonths [%d]" (gSettings) { ecobee="=[123456789012#settings.electricityBillCycleMonths]" } - Number settings_electricityBillStartMonth "electricityBillStartMonth [%d]" (gSettings) { ecobee="=[123456789012#settings.electricityBillStartMonth]" } - Number settings_ventilatorMinOnTimeHome "ventilatorMinOnTimeHome [%d]" (gSettings) { ecobee="=[123456789012#settings.ventilatorMinOnTimeHome]" } - Number settings_ventilatorMinOnTimeAway "ventilatorMinOnTimeAway [%d]" (gSettings) { ecobee="=[123456789012#settings.ventilatorMinOnTimeAway]" } - Switch settings_backlightOffDuringSleep "backlightOffDuringSleep [%s]" (gSettings) { ecobee="=[123456789012#settings.backlightOffDuringSleep]" } - Switch settings_autoAway "autoAway [%s]" (gSettings) { ecobee="<[123456789012#settings.autoAway]" } - Switch settings_smartCirculation "smartCirculation [%s]" (gSettings) { ecobee="=[123456789012#settings.smartCirculation]" } - Switch settings_followMeComfort "followMeComfort [%s]" (gSettings) { ecobee="=[123456789012#settings.followMeComfort]" } - String settings_ventilatorType "ventilatorType [%s]" (gSettings) { ecobee="<[123456789012#settings.ventilatorType]" } - Switch settings_isVentilatorTimerOn "isVentilatorTimerOn [%s]" (gSettings) { ecobee="=[123456789012#settings.isVentilatorTimerOn]" } - DateTime settings_ventilatorOffDateTime "ventilatorOffDateTime [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" (gSettings) { ecobee="<[123456789012#settings.ventilatorOffDateTime]" } - Switch settings_hasUVFilter "hasUVFilter [%s]" (gSettings) { ecobee="=[123456789012#settings.hasUVFilter]" } - Switch settings_coolingLockout "coolingLockout [%s]" (gSettings) { ecobee="=[123456789012#settings.coolingLockout]" } - Switch settings_ventilatorFreeCooling "ventilatorFreeCooling [%s]" (gSettings) { ecobee="=[123456789012#settings.ventilatorFreeCooling]" } - Switch settings_dehumidifyWhenHeating "dehumidifyWhenHeating [%s]" (gSettings) { ecobee="=[123456789012#settings.dehumidifyWhenHeating]" } - String settings_groupRef "groupRef [%s]" (gSettings) { ecobee="=[123456789012#settings.groupRef]" } - String settings_groupName "groupName [%s]" (gSettings) { ecobee="=[123456789012#settings.groupName]" } - Number settings_groupSetting "groupSetting [%d]" (gSettings) { ecobee="=[123456789012#settings.groupSetting]" } - - Group gRuntime (All) - - String runtime_runtimeRev "runtimeRev [%s]" (gRuntime) { ecobee="<[123456789012#runtime.runtimeRev]" } - Switch runtime_connected "connected [%s]" (gRuntime) { ecobee="<[123456789012#runtime.connected]" } - DateTime runtime_firstConnected "firstConnected [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" (gRuntime) { ecobee="<[123456789012#runtime.firstConnected]" } - DateTime runtime_connectDateTime "connectDateTime [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" (gRuntime) { ecobee="<[123456789012#runtime.connectDateTime]" } - String runtime_disconnectDateTime "disconnectDateTime [%s]" (gRuntime) { ecobee="<[123456789012#runtime.disconnectDateTime]" } - DateTime runtime_lastModified "lastModified [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" (gRuntime) { ecobee="<[123456789012#runtime.lastModified]" } - DateTime runtime_lastStatusModified "lastStatusModified [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" (gRuntime) { ecobee="<[123456789012#runtime.lastStatusModified]" } - String runtime_runtimeDate "runtimeDate [%s]" (gRuntime) { ecobee="<[123456789012#runtime.runtimeDate]" } - Number runtime_runtimeInterval "runtimeInterval [%d]" (gRuntime) { ecobee="<[123456789012#runtime.runtimeInterval]" } - Number runtime_actualTemperature "actualTemperature [%.1f °F]" (gRuntime) { ecobee="<[123456789012#runtime.actualTemperature]" } - Number runtime_actualHumidity "actualHumidity [%d %%]" (gRuntime) { ecobee="<[123456789012#runtime.actualHumidity]" } - Number runtime_desiredHeat "desiredHeat [%.1f °F]" (gRuntime) { ecobee="<[123456789012#runtime.desiredHeat]" } - Number runtime_desiredCool "desiredCool [%.1f °F]" (gRuntime) { ecobee="<[123456789012#runtime.desiredCool]" } - Number runtime_desiredHumidity "desiredHumidity [%d %%]" (gRuntime) { ecobee="<[123456789012#runtime.desiredHumidity]" } - Number runtime_desiredDehumidity "desiredDehumidity [%d %%]" (gRuntime) { ecobee="<[123456789012#runtime.desiredDehumidity]" } - String runtime_desiredFanMode "desiredFanMode [%s]" (gRuntime) { ecobee="<[123456789012#runtime.desiredFanMode]" } - - Group gLocation (All) - - Number location_timeZoneOffsetMinutes "timeZoneOffsetMinutes [%d]" (gLocation) { ecobee="<[123456789012#location.timeZoneOffsetMinutes]" } - String location_timeZone "timeZone [%s]" (gLocation) { ecobee="=[123456789012#location.timeZone]" } - Switch location_isDaylightSaving "isDaylightSaving [%s]" (gLocation) { ecobee="=[123456789012#location.isDaylightSaving]" } - String location_streetAddress "streetAddress [%s]" (gLocation) { ecobee="=[123456789012#location.streetAddress]" } - String location_city "city [%s]" (gLocation) { ecobee="=[123456789012#location.city]" } - String location_provinceState "provinceState [%s]" (gLocation) { ecobee="=[123456789012#location.provinceState]" } - String location_country "country [%s]" (gLocation) { ecobee="=[123456789012#location.country]" } - String location_postalCode "postalCode [%s]" (gLocation) { ecobee="=[123456789012#location.postalCode]" } - String location_phoneNumber "phoneNumber [%s]" (gLocation) { ecobee="=[123456789012#location.phoneNumber]" } - String location_mapCoordinates "mapCoordinates [%s]" (gLocation) { ecobee="=[123456789012#location.mapCoordinates]" } - - Group gWeather (All) - - DateTime weather_timestamp "timestamp [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" (gWeather) { ecobee="<[123456789012#weather.timestamp]" } - String weather_weatherStation "weatherStation [%s]" (gWeather) { ecobee="<[123456789012#weather.weatherStation]" } - - Number weather_forecasts0_weatherSymbol "weatherSymbol [MAP(ecobeeWeatherSymbol.map):%d]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].weatherSymbol]" } - DateTime weather_forecasts0_dateTime "dateTime [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].dateTime]" } - String weather_forecasts0_condition "condition [%s]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].condition]" } - Number weather_forecasts0_temperature "temperature [%.1f °F]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].temperature]" } - Number weather_forecasts0_pressure "pressure [%d]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].pressure]" } - Number weather_forecasts0_relativeHumidity "relativeHumidity [%d %%]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].relativeHumidity]" } - Number weather_forecasts0_dewpoint "dewpoint [%d]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].dewpoint]" } - Number weather_forecasts0_visibility "visibility [%d meters]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].visibility]" } - Number weather_forecasts0_windSpeed "windSpeed [%d]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].windSpeed]" } - Number weather_forecasts0_windGust "windGust [%d]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].windGust]" } - String weather_forecasts0_windDirection "windDirection [%s]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].windDirection]" } - Number weather_forecasts0_windBearing "windBearing [%d]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].windBearing]" } - Number weather_forecasts0_pop "pop [%d %%]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].pop]" } - Number weather_forecasts0_tempHigh "tempHigh [%.1f °F]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].tempHigh]" } - Number weather_forecasts0_tempLow "tempLow [%.1f °F]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].tempLow]" } - Number weather_forecasts0_sky "sky [MAP(ecobeeSky.map):%d]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].sky]" } - - Group gHouseDetails (All) - - String houseDetails_style "style [%s]" (gHouseDetails) { ecobee="=[123456789012#houseDetails.style]" } - Number houseDetails_size "size [%d]" (gHouseDetails) { ecobee="=[123456789012#houseDetails.size]" } - Number houseDetails_numberOfFloors "numberOfFloors [%d]" (gHouseDetails) { ecobee="=[123456789012#houseDetails.numberOfFloors]" } - Number houseDetails_numberOfRooms "numberOfRooms [%d]" (gHouseDetails) { ecobee="=[123456789012#houseDetails.numberOfRooms]" } - Number houseDetails_numberOfOccupants "numberOfOccupants [%d]" (gHouseDetails) { ecobee="=[123456789012#houseDetails.numberOfOccupants]" } - Number houseDetails_age "age [%d]" (gHouseDetails) { ecobee="=[123456789012#houseDetails.age]" } - - /* If you have remote sensors named Kitchen and Bedroom connected to an ecobee3 with ID 123456789012 */ - - Group gRemoteSensors (All) - - Number remoteSensors_Kitchen_capability_temperature "Kitchen temp. [%.1f °F]" (gRemoteSensors) { ecobee="<[123456789012#remoteSensors(Kitchen).capability(temperature).value]" } - Switch remoteSensors_Bedroom_capability_occupancy "Bedroom occu. [%s]" (gRemoteSensors) { ecobee="<[123456789012#remoteSensors(Bedroom).capability(occupancy).value]" } - - Group gEvents (All) - - String firstEvent_type "First event type [%s]" (gEvents) { ecobee="<[123456789012#events[0].type]" } - String firstEvent_name "First event name [%s]" (gEvents) { ecobee="<[123456789012#events[0].name]" } - String firstEvent_climate "First event climate [%s]" (gEvents) { ecobee="<[123456789012#events[0].holdClimateRef]" } - - /* runningEvent.* is first event marked running, available as of openHAB 1.8 */ - String runningEvent_type "Running event type [%s]" (gEvents) { ecobee="<[123456789012#runningEvent.type]" } - String runningEvent_name "Running event name [%s]" (gEvents) { ecobee="<[123456789012#runningEvent.name]" } - String runningEvent_climate "Running event climate [%s]" (gEvents) { ecobee="<[123456789012#runningEvent.holdClimateRef]" } - -The mapping of [weather symbol numbers](https://www.ecobee.com/home/developer/api/documentation/v1/objects/WeatherForecast.shtml) to their meanings can be specified if you place the following in the file `transform/ecobeeWeatherSymbol.map`: +Here are some examples of valid item binding strings, as you would define in your `.items` file. Each item binding indicates if it is an in-only binding or bidirectional binding string in the examples below. ``` --2=no_symbol -0=sunny -1=few_clouds -2=partly_cloudy -3=mostly_cloudy -4=overcast -5=drizzle -6=rain -7=freezing_rain -8=showers -9=hail -10=snow -11=flurries -12=freezing_snow -13=blizzard -14=pellets -15=thunderstorm -16=windy -17=tornado -18=fog -19=haze -20=smoke -21=dust --=unknown -``` +/* Ecobee binding items (replace 123456789012 with your thermostat ID) */ -The mapping of the [sky numbers](https://www.ecobee.com/home/developer/api/documentation/v1/objects/WeatherForecast.shtml) to their meanings can be specified if you place the following in the file `transform/ecobeeSky.map`: +String identifier "identifier [%s]" { ecobee="<[123456789012#identifier]" } +String name "name [%s]" { ecobee="=[123456789012#name]" } +String thermostatRev "thermostatRev [%s]" { ecobee="<[123456789012#thermostatRev]" } +String isRegistered "isRegistered [%s]" { ecobee="<[123456789012#isRegistered]" } +String modelNumber "modelNumber [%s]" { ecobee="<[123456789012#modelNumber]" } +String brand "brand [%s]" { ecobee="<[123456789012#brand]" } // as of openHAB 1.8 +String features "features [%s]" { ecobee="<[123456789012#features]" } // as of openHAB 1.8 +DateTime lastModified "lastModified [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" { ecobee="<[123456789012#lastModified]" } +DateTime thermostatTime "thermostatTime [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" { ecobee="<[123456789012#thermostatTime]" } +DateTime utcTime "utcTime [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" { ecobee="<[123456789012#utcTime]" } +String equipmentStatus "equipmentStatus [%s]" { ecobee="<[123456789012#equipmentStatus]" } +String version_thermostatFirmwareVersion "thermostatFirmwareVersion [%s]" { ecobee="<[123456789012#version.thermostatFirmwareVersion]" } +String program_currentClimateRef "currentClimateRef [%s]" { ecobee="<[123456789012#program.currentClimateRef]" } -``` -1=SUNNY -2=CLEAR -3=MOSTLY SUNNY -4=MOSTLY CLEAR -5=HAZY SUNSHINE -6=HAZE -7=PASSING CLOUDS -8=MORE SUN THAN CLOUDS -9=SCATTERED CLOUDS -10=PARTLY CLOUDY -11=A MIXTURE OF SUN AND CLOUDS -12=HIGH LEVEL CLOUDS -13=MORE CLOUDS THAN SUN -14=PARTLY SUNNY -15=BROKEN CLOUDS -16=MOSTLY CLOUDY -17=CLOUDY -18=OVERCAST -19=LOW CLOUDS -20=LIGHT FOG -21=FOG -22=DENSE FOG -23=ICE FOG -24=SANDSTORM -25=DUSTSTORM -26=INCREASING CLOUDINESS -27=DECREASING CLOUDINESS -28=CLEARING SKIES -29=BREAKS OF SUN LATE -30=EARLY FOG FOLLOWED BY SUNNY SKIES -31=AFTERNOON CLOUDS -32=MORNING CLOUDS -33=SMOKE -34=LOW LEVEL HAZE --=UNKNOWN -``` +Group All +Group gSettings (All) -## More Examples +String settings_hvacMode "hvacMode [%s]" (gSettings) { ecobee="=[123456789012#settings.hvacMode]" } +String settings_lastServiceDate "lastServiceDate [%s]" (gSettings) { ecobee="=[123456789012#settings.lastServiceDate]" } +Switch settings_serviceRemindMe "serviceRemindMe [%s]" (gSettings) { ecobee="=[123456789012#settings.serviceRemindMe]" } +Number settings_monthsBetweenService "monthsBetweenService [%d]" (gSettings) { ecobee="=[123456789012#settings.monthsBetweenService]" } +String settings_remindMeDate "remindMeDate [%s]" (gSettings) { ecobee="=[123456789012#settings.remindMeDate]" } +String settings_vent "vent [%s]" (gSettings) { ecobee="=[123456789012#settings.vent]" } +Number settings_ventilatorMinOnTime "ventilatorMinOnTime [%d]" (gSettings) { ecobee="=[123456789012#settings.ventilatorMinOnTime]" } +Switch settings_serviceRemindTechnician "serviceRemindTechnician [%s]" (gSettings) { ecobee="=[123456789012#settings.serviceRemindTechnician]" } +String settings_eiLocation "eiLocation [%s]" (gSettings) { ecobee="=[123456789012#settings.eiLocation]" } +Number settings_coldTempAlert "coldTempAlert [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.coldTempAlert]" } +Switch settings_coldTempAlertEnabled "coldTempAlertEnabled [%s]" (gSettings) { ecobee="=[123456789012#settings.coldTempAlertEnabled]" } +Number settings_hotTempAlert "hotTempAlert [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.hotTempAlert]" } +Switch settings_hotTempAlertEnabled "hotTempAlertEnabled [%s]" (gSettings) { ecobee="=[123456789012#settings.hotTempAlertEnabled]" } +Number settings_coolStages "coolStages [%d]" (gSettings) { ecobee="<[123456789012#settings.coolStages]" } +Number settings_heatStages "heatStages [%d]" (gSettings) { ecobee="<[123456789012#settings.heatStages]" } +Number settings_maxSetBack "maxSetBack [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.maxSetBack]" } +Number settings_maxSetForward "maxSetForward [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.maxSetForward]" } +Number settings_quickSaveSetBack "quickSaveSetBack [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.quickSaveSetBack]" } +Number settings_quickSaveSetForward "quickSaveSetForward [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.quickSaveSetForward]" } +Switch settings_hasHeatPump "hasHeatPump [%s]" (gSettings) { ecobee="<[123456789012#settings.hasHeatPump]" } +Switch settings_hasForcedAir "hasForcedAir [%s]" (gSettings) { ecobee="<[123456789012#settings.hasForcedAir]" } +Switch settings_hasBoiler "hasBoiler [%s]" (gSettings) { ecobee="<[123456789012#settings.hasBoiler]" } +Switch settings_hasHumidifier "hasHumidifier [%s]" (gSettings) { ecobee="<[123456789012#settings.hasHumidifier]" } +Switch settings_hasErv "hasErv [%s]" (gSettings) { ecobee="<[123456789012#settings.hasErv]" } +Switch settings_hasHrv "hasHrv [%s]" (gSettings) { ecobee="<[123456789012#settings.hasHrv]" } +Switch settings_condensationAvoid "condensationAvoid [%s]" (gSettings) { ecobee="=[123456789012#settings.condensationAvoid]" } +Switch settings_useCelsius "useCelsius [%s]" (gSettings) { ecobee="=[123456789012#settings.useCelsius]" } +Switch settings_useTimeFormat12 "useTimeFormat12 [%s]" (gSettings) { ecobee="=[123456789012#settings.useTimeFormat12]" } +String settings_locale "locale [%s]" (gSettings) { ecobee="=[123456789012#settings.locale]" } +String settings_humidity "humidity [%s]" (gSettings) { ecobee="=[123456789012#settings.humidity]" } +String settings_humidifierMode "humidifierMode [%s]" (gSettings) { ecobee="=[123456789012#settings.humidifierMode]" } +Number settings_backlightOnIntensity "backlightOnIntensity [%d]" (gSettings) { ecobee="=[123456789012#settings.backlightOnIntensity]" } +Number settings_backlightSleepIntensity "backlightSleepIntensity [%d]" (gSettings) { ecobee="=[123456789012#settings.backlightSleepIntensity]" } +Number settings_backlightOffTime "backlightOffTime [%d]" (gSettings) { ecobee="=[123456789012#settings.backlightOffTime]" } +Number settings_soundTickVolume "soundTickVolume [%d]" (gSettings) { ecobee="=[123456789012#settings.soundTickVolume]" } +Number settings_soundAlertVolume "soundAlertVolume [%d]" (gSettings) { ecobee="=[123456789012#settings.soundAlertVolume]" } +Number settings_compressorProtectionMinTime "compressorProtectionMinTime [%d]" (gSettings) { ecobee="=[123456789012#settings.compressorProtectionMinTime]" } +Number settings_compressorProtectionMinTemp "compressorProtectionMinTemp [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.compressorProtectionMinTemp]" } +Number settings_stage1HeatingDifferentialTemp "stage1HeatingDifferentialTemp [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.stage1HeatingDifferentialTemp]" } +Number settings_stage1CoolingDifferentialTemp "stage1CoolingDifferentialTemp [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.stage1CoolingDifferentialTemp]" } +Number settings_stage1HeatingDissipationTime "stage1HeatingDissipationTime [%d]" (gSettings) { ecobee="=[123456789012#settings.stage1HeatingDissipationTime]" } +Number settings_stage1CoolingDissipationTime "stage1CoolingDissipationTime [%d]" (gSettings) { ecobee="=[123456789012#settings.stage1CoolingDissipationTime]" } +Switch settings_heatPumpReversalOnCool "heatPumpReversalOnCool [%s]" (gSettings) { ecobee="=[123456789012#settings.heatPumpReversalOnCool]" } +Switch settings_fanControlRequired "fanControlRequired [%s]" (gSettings) { ecobee="=[123456789012#settings.fanControlRequired]" } +Number settings_fanMinOnTime "fanMinOnTime [%d]" (gSettings) { ecobee="=[123456789012#settings.fanMinOnTime]" } +Number settings_heatCoolMinDelta "heatCoolMinDelta [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.heatCoolMinDelta]" } +Number settings_tempCorrection "tempCorrection [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.tempCorrection]" } +String settings_holdAction "holdAction [%s]" (gSettings) { ecobee="=[123456789012#settings.holdAction]" } +Switch settings_heatPumpGroundWater "heatPumpGroundWater [%s]" (gSettings) { ecobee="<[123456789012#settings.heatPumpGroundWater]" } +Switch settings_hasElectric "hasElectric [%s]" (gSettings) { ecobee="<[123456789012#settings.hasElectric]" } +Switch settings_hasDehumidifier "hasDehumidifier [%s]" (gSettings) { ecobee="<[123456789012#settings.hasDehumidifier]" } +String settings_dehumidifierMode "dehumidifierMode [%s]" (gSettings) { ecobee="=[123456789012#settings.dehumidifierMode]" } +Number settings_dehumidifierLevel "dehumidifierLevel [%d]" (gSettings) { ecobee="=[123456789012#settings.dehumidifierLevel]" } +Switch settings_dehumidifyWithAC "dehumidifyWithAC [%s]" (gSettings) { ecobee="=[123456789012#settings.dehumidifyWithAC]" } +Number settings_dehumidifyOvercoolOffset "dehumidifyOvercoolOffset [%d]" (gSettings) { ecobee="=[123456789012#settings.dehumidifyOvercoolOffset]" } +Switch settings_autoHeatCoolFeatureEnabled "autoHeatCoolFeatureEnabled [%s]" (gSettings) { ecobee="=[123456789012#settings.autoHeatCoolFeatureEnabled]" } +Switch settings_wifiOfflineAlert "wifiOfflineAlert [%s]" (gSettings) { ecobee="=[123456789012#settings.wifiOfflineAlert]" } +Number settings_heatMinTemp "heatMinTemp [%.1f °F]" (gSettings) { ecobee="<[123456789012#settings.heatMinTemp]" } +Number settings_heatMaxTemp "heatMaxTemp [%.1f °F]" (gSettings) { ecobee="<[123456789012#settings.heatMaxTemp]" } +Number settings_coolMinTemp "coolMinTemp [%.1f °F]" (gSettings) { ecobee="<[123456789012#settings.coolMinTemp]" } +Number settings_coolMaxTemp "coolMaxTemp [%.1f °F]" (gSettings) { ecobee="<[123456789012#settings.coolMaxTemp]" } +Number settings_heatRangeHigh "heatRangeHigh [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.heatRangeHigh]" } +Number settings_heatRangeLow "heatRangeLow [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.heatRangeLow]" } +Number settings_coolRangeHigh "coolRangeHigh [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.coolRangeHigh]" } +Number settings_coolRangeLow "coolRangeLow [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.coolRangeLow]" } +String settings_userAccessCode "userAccessCode [%s]" (gSettings) { ecobee="=[123456789012#settings.userAccessCode]" } +Number settings_userAccessSetting "userAccessSetting [%d]" (gSettings) { ecobee="=[123456789012#settings.userAccessSetting]" } +Number settings_auxRuntimeAlert "auxRuntimeAlert [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.auxRuntimeAlert]" } +Number settings_auxOutdoorTempAlert "auxOutdoorTempAlert [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.auxOutdoorTempAlert]" } +Number settings_auxMaxOutdoorTemp "auxMaxOutdoorTemp [%.1f °F]" (gSettings) { ecobee="=[123456789012#settings.auxMaxOutdoorTemp]" } +Switch settings_auxRuntimeAlertNotify "auxRuntimeAlertNotify [%s]" (gSettings) { ecobee="=[123456789012#settings.auxRuntimeAlertNotify]" } +Switch settings_auxOutdoorTempAlertNotify "auxOutdoorTempAlertNotify [%s]" (gSettings) { ecobee="=[123456789012#settings.auxOutdoorTempAlertNotify]" } +Switch settings_auxRuntimeAlertNotifyTechnician "auxRuntimeAlertNotifyTechnician [%s]" (gSettings) { ecobee="=[123456789012#settings.auxRuntimeAlertNotifyTechnician]" } +Switch settings_auxOutdoorTempAlertNotifyTechnician "auxOutdoorTempAlertNotifyTechnician [%s]" (gSettings) { ecobee="=[123456789012#settings.auxOutdoorTempAlertNotifyTechnician]" } +Switch settings_disablePreHeating "disablePreHeating [%s]" (gSettings) { ecobee="=[123456789012#settings.disablePreHeating]" } +Switch settings_disablePreCooling "disablePreCooling [%s]" (gSettings) { ecobee="=[123456789012#settings.disablePreCooling]" } +Switch settings_installerCodeRequired "installerCodeRequired [%s]" (gSettings) { ecobee="=[123456789012#settings.installerCodeRequired]" } +String settings_drAccept "drAccept [%s]" (gSettings) { ecobee="=[123456789012#settings.drAccept]" } +Switch settings_isRentalProperty "isRentalProperty [%s]" (gSettings) { ecobee="=[123456789012#settings.isRentalProperty]" } +Switch settings_useZoneController "useZoneController [%s]" (gSettings) { ecobee="=[123456789012#settings.useZoneController]" } +Number settings_randomStartDelayCool "randomStartDelayCool [%d]" (gSettings) { ecobee="=[123456789012#settings.randomStartDelayCool]" } +Number settings_randomStartDelayHeat "randomStartDelayHeat [%d]" (gSettings) { ecobee="=[123456789012#settings.randomStartDelayHeat]" } +Number settings_humidityHighAlert "humidityHighAlert [%d]" (gSettings) { ecobee="=[123456789012#settings.humidityHighAlert]" } +Number settings_humidityLowAlert "humidityLowAlert [%d]" (gSettings) { ecobee="=[123456789012#settings.humidityLowAlert]" } +Switch settings_disableHeatPumpAlerts "disableHeatPumpAlerts [%s]" (gSettings) { ecobee="=[123456789012#settings.disableHeatPumpAlerts]" } +Switch settings_disableAlertsOnIdt "disableAlertsOnIdt [%s]" (gSettings) { ecobee="=[123456789012#settings.disableAlertsOnIdt]" } +Switch settings_humidityAlertNotify "humidityAlertNotify [%s]" (gSettings) { ecobee="=[123456789012#settings.humidityAlertNotify]" } +Switch settings_humidityAlertNotifyTechnician "humidityAlertNotifyTechnician [%s]" (gSettings) { ecobee="=[123456789012#settings.humidityAlertNotifyTechnician]" } +Switch settings_tempAlertNotify "tempAlertNotify [%s]" (gSettings) { ecobee="=[123456789012#settings.tempAlertNotify]" } +Switch settings_tempAlertNotifyTechnician "tempAlertNotifyTechnician [%s]" (gSettings) { ecobee="=[123456789012#settings.tempAlertNotifyTechnician]" } +Number settings_monthlyElectricityBillLimit "monthlyElectricityBillLimit [%d]" (gSettings) { ecobee="=[123456789012#settings.monthlyElectricityBillLimit]" } +Switch settings_enableElectricityBillAlert "enableElectricityBillAlert [%s]" (gSettings) { ecobee="=[123456789012#settings.enableElectricityBillAlert]" } +Switch settings_enableProjectedElectricityBillAlert "enableProjectedElectricityBillAlert [%s]" (gSettings) { ecobee="=[123456789012#settings.enableProjectedElectricityBillAlert]" } +Number settings_electricityBillingDayOfMonth "electricityBillingDayOfMonth [%d]" (gSettings) { ecobee="=[123456789012#settings.electricityBillingDayOfMonth]" } +Number settings_electricityBillCycleMonths "electricityBillCycleMonths [%d]" (gSettings) { ecobee="=[123456789012#settings.electricityBillCycleMonths]" } +Number settings_electricityBillStartMonth "electricityBillStartMonth [%d]" (gSettings) { ecobee="=[123456789012#settings.electricityBillStartMonth]" } +Number settings_ventilatorMinOnTimeHome "ventilatorMinOnTimeHome [%d]" (gSettings) { ecobee="=[123456789012#settings.ventilatorMinOnTimeHome]" } +Number settings_ventilatorMinOnTimeAway "ventilatorMinOnTimeAway [%d]" (gSettings) { ecobee="=[123456789012#settings.ventilatorMinOnTimeAway]" } +Switch settings_backlightOffDuringSleep "backlightOffDuringSleep [%s]" (gSettings) { ecobee="=[123456789012#settings.backlightOffDuringSleep]" } +Switch settings_autoAway "autoAway [%s]" (gSettings) { ecobee="<[123456789012#settings.autoAway]" } +Switch settings_smartCirculation "smartCirculation [%s]" (gSettings) { ecobee="=[123456789012#settings.smartCirculation]" } +Switch settings_followMeComfort "followMeComfort [%s]" (gSettings) { ecobee="=[123456789012#settings.followMeComfort]" } +String settings_ventilatorType "ventilatorType [%s]" (gSettings) { ecobee="<[123456789012#settings.ventilatorType]" } +Switch settings_isVentilatorTimerOn "isVentilatorTimerOn [%s]" (gSettings) { ecobee="=[123456789012#settings.isVentilatorTimerOn]" } +DateTime settings_ventilatorOffDateTime "ventilatorOffDateTime [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" (gSettings) { ecobee="<[123456789012#settings.ventilatorOffDateTime]" } +Switch settings_hasUVFilter "hasUVFilter [%s]" (gSettings) { ecobee="=[123456789012#settings.hasUVFilter]" } +Switch settings_coolingLockout "coolingLockout [%s]" (gSettings) { ecobee="=[123456789012#settings.coolingLockout]" } +Switch settings_ventilatorFreeCooling "ventilatorFreeCooling [%s]" (gSettings) { ecobee="=[123456789012#settings.ventilatorFreeCooling]" } +Switch settings_dehumidifyWhenHeating "dehumidifyWhenHeating [%s]" (gSettings) { ecobee="=[123456789012#settings.dehumidifyWhenHeating]" } +String settings_groupRef "groupRef [%s]" (gSettings) { ecobee="=[123456789012#settings.groupRef]" } +String settings_groupName "groupName [%s]" (gSettings) { ecobee="=[123456789012#settings.groupName]" } +Number settings_groupSetting "groupSetting [%d]" (gSettings) { ecobee="=[123456789012#settings.groupSetting]" } + +Group gRuntime (All) + +String runtime_runtimeRev "runtimeRev [%s]" (gRuntime) { ecobee="<[123456789012#runtime.runtimeRev]" } +Switch runtime_connected "connected [%s]" (gRuntime) { ecobee="<[123456789012#runtime.connected]" } +DateTime runtime_firstConnected "firstConnected [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" (gRuntime) { ecobee="<[123456789012#runtime.firstConnected]" } +DateTime runtime_connectDateTime "connectDateTime [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" (gRuntime) { ecobee="<[123456789012#runtime.connectDateTime]" } +String runtime_disconnectDateTime "disconnectDateTime [%s]" (gRuntime) { ecobee="<[123456789012#runtime.disconnectDateTime]" } +DateTime runtime_lastModified "lastModified [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" (gRuntime) { ecobee="<[123456789012#runtime.lastModified]" } +DateTime runtime_lastStatusModified "lastStatusModified [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" (gRuntime) { ecobee="<[123456789012#runtime.lastStatusModified]" } +String runtime_runtimeDate "runtimeDate [%s]" (gRuntime) { ecobee="<[123456789012#runtime.runtimeDate]" } +Number runtime_runtimeInterval "runtimeInterval [%d]" (gRuntime) { ecobee="<[123456789012#runtime.runtimeInterval]" } +Number runtime_actualTemperature "actualTemperature [%.1f °F]" (gRuntime) { ecobee="<[123456789012#runtime.actualTemperature]" } +Number runtime_actualHumidity "actualHumidity [%d %%]" (gRuntime) { ecobee="<[123456789012#runtime.actualHumidity]" } +Number runtime_desiredHeat "desiredHeat [%.1f °F]" (gRuntime) { ecobee="<[123456789012#runtime.desiredHeat]" } +Number runtime_desiredCool "desiredCool [%.1f °F]" (gRuntime) { ecobee="<[123456789012#runtime.desiredCool]" } +Number runtime_desiredHumidity "desiredHumidity [%d %%]" (gRuntime) { ecobee="<[123456789012#runtime.desiredHumidity]" } +Number runtime_desiredDehumidity "desiredDehumidity [%d %%]" (gRuntime) { ecobee="<[123456789012#runtime.desiredDehumidity]" } +String runtime_desiredFanMode "desiredFanMode [%s]" (gRuntime) { ecobee="<[123456789012#runtime.desiredFanMode]" } + +Group gLocation (All) + +Number location_timeZoneOffsetMinutes "timeZoneOffsetMinutes [%d]" (gLocation) { ecobee="<[123456789012#location.timeZoneOffsetMinutes]" } +String location_timeZone "timeZone [%s]" (gLocation) { ecobee="=[123456789012#location.timeZone]" } +Switch location_isDaylightSaving "isDaylightSaving [%s]" (gLocation) { ecobee="=[123456789012#location.isDaylightSaving]" } +String location_streetAddress "streetAddress [%s]" (gLocation) { ecobee="=[123456789012#location.streetAddress]" } +String location_city "city [%s]" (gLocation) { ecobee="=[123456789012#location.city]" } +String location_provinceState "provinceState [%s]" (gLocation) { ecobee="=[123456789012#location.provinceState]" } +String location_country "country [%s]" (gLocation) { ecobee="=[123456789012#location.country]" } +String location_postalCode "postalCode [%s]" (gLocation) { ecobee="=[123456789012#location.postalCode]" } +String location_phoneNumber "phoneNumber [%s]" (gLocation) { ecobee="=[123456789012#location.phoneNumber]" } +String location_mapCoordinates "mapCoordinates [%s]" (gLocation) { ecobee="=[123456789012#location.mapCoordinates]" } + +Group gWeather (All) + +DateTime weather_timestamp "timestamp [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" (gWeather) { ecobee="<[123456789012#weather.timestamp]" } +String weather_weatherStation "weatherStation [%s]" (gWeather) { ecobee="<[123456789012#weather.weatherStation]" } + +Number weather_forecasts0_weatherSymbol "weatherSymbol [MAP(ecobeeWeatherSymbol.map):%d]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].weatherSymbol]" } +DateTime weather_forecasts0_dateTime "dateTime [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].dateTime]" } +String weather_forecasts0_condition "condition [%s]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].condition]" } +Number weather_forecasts0_temperature "temperature [%.1f °F]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].temperature]" } +Number weather_forecasts0_pressure "pressure [%d]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].pressure]" } +Number weather_forecasts0_relativeHumidity "relativeHumidity [%d %%]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].relativeHumidity]" } +Number weather_forecasts0_dewpoint "dewpoint [%d]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].dewpoint]" } +Number weather_forecasts0_visibility "visibility [%d meters]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].visibility]" } +Number weather_forecasts0_windSpeed "windSpeed [%d]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].windSpeed]" } +Number weather_forecasts0_windGust "windGust [%d]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].windGust]" } +String weather_forecasts0_windDirection "windDirection [%s]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].windDirection]" } +Number weather_forecasts0_windBearing "windBearing [%d]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].windBearing]" } +Number weather_forecasts0_pop "pop [%d %%]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].pop]" } +Number weather_forecasts0_tempHigh "tempHigh [%.1f °F]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].tempHigh]" } +Number weather_forecasts0_tempLow "tempLow [%.1f °F]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].tempLow]" } +Number weather_forecasts0_sky "sky [MAP(ecobeeSky.map):%d]" (gWeather) { ecobee="<[123456789012#weather.forecasts[0].sky]" } + +Group gHouseDetails (All) + +String houseDetails_style "style [%s]" (gHouseDetails) { ecobee="=[123456789012#houseDetails.style]" } +Number houseDetails_size "size [%d]" (gHouseDetails) { ecobee="=[123456789012#houseDetails.size]" } +Number houseDetails_numberOfFloors "numberOfFloors [%d]" (gHouseDetails) { ecobee="=[123456789012#houseDetails.numberOfFloors]" } +Number houseDetails_numberOfRooms "numberOfRooms [%d]" (gHouseDetails) { ecobee="=[123456789012#houseDetails.numberOfRooms]" } +Number houseDetails_numberOfOccupants "numberOfOccupants [%d]" (gHouseDetails) { ecobee="=[123456789012#houseDetails.numberOfOccupants]" } +Number houseDetails_age "age [%d]" (gHouseDetails) { ecobee="=[123456789012#houseDetails.age]" } + +/* If you have remote sensors named Kitchen and Bedroom connected to an ecobee3 with ID 123456789012 */ + +Group gRemoteSensors (All) + +Number remoteSensors_Kitchen_capability_temperature "Kitchen temp. [%.1f °F]" (gRemoteSensors) { ecobee="<[123456789012#remoteSensors(Kitchen).capability(temperature).value]" } +Switch remoteSensors_Bedroom_capability_occupancy "Bedroom occu. [%s]" (gRemoteSensors) { ecobee="<[123456789012#remoteSensors(Bedroom).capability(occupancy).value]" } + +Group gEvents (All) + +String firstEvent_type "First event type [%s]" (gEvents) { ecobee="<[123456789012#events[0].type]" } +String firstEvent_name "First event name [%s]" (gEvents) { ecobee="<[123456789012#events[0].name]" } +String firstEvent_climate "First event climate [%s]" (gEvents) { ecobee="<[123456789012#events[0].holdClimateRef]" } + +/* runningEvent.* is first event marked running, available as of openHAB 1.8 */ +String runningEvent_type "Running event type [%s]" (gEvents) { ecobee="<[123456789012#runningEvent.type]" } +String runningEvent_name "Running event name [%s]" (gEvents) { ecobee="<[123456789012#runningEvent.name]" } +String runningEvent_climate "Running event climate [%s]" (gEvents) { ecobee="<[123456789012#runningEvent.holdClimateRef]" } +``` ### Basic configuration @@ -638,11 +600,6 @@ then end ``` -### Notes - -1. Ecobee thermostats normally run based on a weekly schedule, but you can override the current program by setting a hold that controls the cool setpoint, the heat setpoint, and other options. You can set a hold from a rule by calling the action `ecobeeSetHold`. One of the parameters is a reference to a "climate" (also known as a comfort setting). The default references for climates are `sleep`, `home`, and `away` (some models also have `wakeup`). - - ### Tracking last occupancy The ecobee3 thermostat can connect to a number of wireless remote sensors that measure occupancy and temperature. The thermostat normally uses these to implement its "follow-me comfort" feature, where the thermostat is constantly adjusting its idea of the current ambient temperature based on an average of the temperatures of rooms that are currently occupied. @@ -687,3 +644,79 @@ then } end ``` + +### MAP Transformations + +The mapping of [weather symbol numbers](https://www.ecobee.com/home/developer/api/documentation/v1/objects/WeatherForecast.shtml) to their meanings can be specified if you place the following in the file `transform/ecobeeWeatherSymbol.map`: + +``` +-2=no_symbol +0=sunny +1=few_clouds +2=partly_cloudy +3=mostly_cloudy +4=overcast +5=drizzle +6=rain +7=freezing_rain +8=showers +9=hail +10=snow +11=flurries +12=freezing_snow +13=blizzard +14=pellets +15=thunderstorm +16=windy +17=tornado +18=fog +19=haze +20=smoke +21=dust +-=unknown +``` + +The mapping of the [sky numbers](https://www.ecobee.com/home/developer/api/documentation/v1/objects/WeatherForecast.shtml) to their meanings can be specified if you place the following in the file `transform/ecobeeSky.map`: + +``` +1=SUNNY +2=CLEAR +3=MOSTLY SUNNY +4=MOSTLY CLEAR +5=HAZY SUNSHINE +6=HAZE +7=PASSING CLOUDS +8=MORE SUN THAN CLOUDS +9=SCATTERED CLOUDS +10=PARTLY CLOUDY +11=A MIXTURE OF SUN AND CLOUDS +12=HIGH LEVEL CLOUDS +13=MORE CLOUDS THAN SUN +14=PARTLY SUNNY +15=BROKEN CLOUDS +16=MOSTLY CLOUDY +17=CLOUDY +18=OVERCAST +19=LOW CLOUDS +20=LIGHT FOG +21=FOG +22=DENSE FOG +23=ICE FOG +24=SANDSTORM +25=DUSTSTORM +26=INCREASING CLOUDINESS +27=DECREASING CLOUDINESS +28=CLEARING SKIES +29=BREAKS OF SUN LATE +30=EARLY FOG FOLLOWED BY SUNNY SKIES +31=AFTERNOON CLOUDS +32=MORNING CLOUDS +33=SMOKE +34=LOW LEVEL HAZE +-=UNKNOWN +``` + + +## Notes + +1. Ecobee thermostats normally run based on a weekly schedule, but you can override the current program by setting a hold that controls the cool setpoint, the heat setpoint, and other options. You can set a hold from a rule by calling the action `ecobeeSetHold`. One of the parameters is a reference to a "climate" (also known as a comfort setting). The default references for climates are `sleep`, `home`, and `away` (some models also have `wakeup`). diff --git a/addons/bindings/oh1/ecotouch/readme.md b/addons/bindings/oh1/ecotouch/readme.md index 774521d2f..562f0fc42 100644 --- a/addons/bindings/oh1/ecotouch/readme.md +++ b/addons/bindings/oh1/ecotouch/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: EcoTouch - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/ekey/readme.md b/addons/bindings/oh1/ekey/readme.md index b8e0cb001..04b2fd319 100644 --- a/addons/bindings/oh1/ekey/readme.md +++ b/addons/bindings/oh1/ekey/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: ekey - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/energenie/readme.md b/addons/bindings/oh1/energenie/readme.md index 62c0ff4b1..6699c05f1 100644 --- a/addons/bindings/oh1/energenie/readme.md +++ b/addons/bindings/oh1/energenie/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Energenie - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/enocean/readme.md b/addons/bindings/oh1/enocean/readme.md index 651c07e4f..be1134774 100644 --- a/addons/bindings/oh1/enocean/readme.md +++ b/addons/bindings/oh1/enocean/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: EnOcean - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/enphaseenergy/readme.md b/addons/bindings/oh1/enphaseenergy/readme.md index 07a5b8d2e..20f96914b 100644 --- a/addons/bindings/oh1/enphaseenergy/readme.md +++ b/addons/bindings/oh1/enphaseenergy/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Enphase Energy - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/epsonprojector/readme.md b/addons/bindings/oh1/epsonprojector/readme.md index 3598cb65c..d4cacd4d6 100644 --- a/addons/bindings/oh1/epsonprojector/readme.md +++ b/addons/bindings/oh1/epsonprojector/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Epson Projector - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/exec/readme.md b/addons/bindings/oh1/exec/readme.md index f10f124c8..99d6b8d12 100644 --- a/addons/bindings/oh1/exec/readme.md +++ b/addons/bindings/oh1/exec/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Exec - Bindings +source: external --- + {% include base.html %} @@ -12,7 +15,7 @@ The Exec binding could act as the opposite of WoL and sends a shutdown command t Note: when using 'ssh' you should use private key authorization since the password cannot be read from commandline. The given user should have the necessary permissions. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/exec/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/exec/readme.html). ## Binding Confguration diff --git a/addons/bindings/oh1/expire/readme.md b/addons/bindings/oh1/expire/readme.md index 99afbeaf6..f8789ec04 100644 --- a/addons/bindings/oh1/expire/readme.md +++ b/addons/bindings/oh1/expire/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Expire - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/fatekplc/readme.md b/addons/bindings/oh1/fatekplc/readme.md index 29214a55f..2656aed8e 100644 --- a/addons/bindings/oh1/fatekplc/readme.md +++ b/addons/bindings/oh1/fatekplc/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Fatek PLC - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/fht/readme.md b/addons/bindings/oh1/fht/readme.md index 3b8c618ce..9d5e277a6 100644 --- a/addons/bindings/oh1/fht/readme.md +++ b/addons/bindings/oh1/fht/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: FHT - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/freebox/readme.md b/addons/bindings/oh1/freebox/readme.md index 2a28582ff..cac0f342c 100644 --- a/addons/bindings/oh1/freebox/readme.md +++ b/addons/bindings/oh1/freebox/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Freebox - Bindings +source: external --- + {% include base.html %} @@ -29,7 +32,7 @@ And act on: - Windows printer sharing status (from v1.7) - Reboot -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/freebox/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/freebox/readme.html). ## Binding Configuration diff --git a/addons/bindings/oh1/freeswitch/readme.md b/addons/bindings/oh1/freeswitch/readme.md index 7e1b812ed..51b95f7e5 100644 --- a/addons/bindings/oh1/freeswitch/readme.md +++ b/addons/bindings/oh1/freeswitch/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: FreeSWITCH - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/fritzaha/readme.md b/addons/bindings/oh1/fritzaha/readme.md index dd4f1d6aa..3b0af3a14 100644 --- a/addons/bindings/oh1/fritzaha/readme.md +++ b/addons/bindings/oh1/fritzaha/readme.md @@ -1,18 +1,21 @@ --- layout: documentation +title: Fritz AHA - Bindings +source: external --- + {% include base.html %} # Fritz AHA Binding -[![Fritz AHA](http://img.youtube.com/vi/qYrpPrLY868/0.jpg)](http://www.youtube.com/watch?v=qYrpPrLY868) - This binding provides access to AVM Home Automation devices, such as the Fritz!DECT 200 connected to a Fritz!Box or the Fritz!Powerline 546E. It is designed to allow for multiple hosts, for instance using both a Fritz!Box and a Fritz!Powerline. +[![Fritz AHA](http://img.youtube.com/vi/qYrpPrLY868/0.jpg)](http://www.youtube.com/watch?v=qYrpPrLY868) + The binding interfaces with hosts using a choice of two different interfaces, the query script used in the Fritz!OS UI and a webservice designed for interfacing with external applications. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/avmfritz/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/avmfritz/readme.html). ## Binding Configuration diff --git a/addons/bindings/oh1/fritzbox/readme.md b/addons/bindings/oh1/fritzbox/readme.md index 5d29de3cc..5ef402cf2 100644 --- a/addons/bindings/oh1/fritzbox/readme.md +++ b/addons/bindings/oh1/fritzbox/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Fritz!Box - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/fritzboxtr064/readme.md b/addons/bindings/oh1/fritzboxtr064/readme.md index c399e8b52..9e37ae848 100644 --- a/addons/bindings/oh1/fritzboxtr064/readme.md +++ b/addons/bindings/oh1/fritzboxtr064/readme.md @@ -1,12 +1,17 @@ --- layout: documentation +title: Fritzbox (using TR064 protocol) - Bindings +source: external --- + {% include base.html %} # Fritzbox Binding (using TR064 protocol) -This is a binding for communication with AVM Fritz!Box using SOAP requests (TR064 protocol). It has been tested on: +This is a binding for communication with AVM Fritz!Box using SOAP requests (TR064 protocol). + +It has been tested on: * 7270 * 7360SL (v6.30) diff --git a/addons/bindings/oh1/frontiersiliconradio/readme.md b/addons/bindings/oh1/frontiersiliconradio/readme.md index 5acd8cee0..0c37faa39 100644 --- a/addons/bindings/oh1/frontiersiliconradio/readme.md +++ b/addons/bindings/oh1/frontiersiliconradio/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Frontier Silicon Radio - Bindings +source: external --- + {% include base.html %} @@ -30,7 +33,7 @@ You can easily check if your IP radio is supported: 4. If the response is similar to `FS_OK 6836164442`, your radio is most likely compatible with this binding 5. If you radio works with this binding, please add it to the list above by [Editing this page](Frontier-Silicon-Radio-Binding/_edit)! -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/fsinternetradio/readme.html) +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/fsinternetradio/readme.html). ## Binding Configuration diff --git a/addons/bindings/oh1/fs20/readme.md b/addons/bindings/oh1/fs20/readme.md index b6b1c31c9..71536ac3d 100644 --- a/addons/bindings/oh1/fs20/readme.md +++ b/addons/bindings/oh1/fs20/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: FS20 - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/garadget/readme.md b/addons/bindings/oh1/garadget/readme.md index 4b33304e4..a0edd7517 100644 --- a/addons/bindings/oh1/garadget/readme.md +++ b/addons/bindings/oh1/garadget/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Garadget - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/gc100ir/readme.md b/addons/bindings/oh1/gc100ir/readme.md index b288a889f..04e856111 100644 --- a/addons/bindings/oh1/gc100ir/readme.md +++ b/addons/bindings/oh1/gc100ir/readme.md @@ -1,16 +1,19 @@ --- layout: documentation +title: Global Cache IR - Bindings +source: external --- + {% include base.html %} -# Global Cache IR Binding (1.x) +# Global Cache IR Binding This page describes the Global Cache IR binding (1.x), which allows openHAB items to send commands to the corresponding IR devices from one or more instances of Global Cache. ![Global Cache Device](http://www.smarthome.com/media/catalog/product/8/1/8115big.jpg) -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/globalcache/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/globalcache/readme.html). ## Binding Configuration diff --git a/addons/bindings/oh1/gpio/readme.md b/addons/bindings/oh1/gpio/readme.md index 4647c48d5..4a6badb74 100644 --- a/addons/bindings/oh1/gpio/readme.md +++ b/addons/bindings/oh1/gpio/readme.md @@ -1,12 +1,17 @@ --- layout: documentation +title: GPIO - Bindings +source: external --- + {% include base.html %} # GPIO Binding -This binding for the local GPIO subsystem, currently only this exposed to user space by [Linux GPIO framework](https://www.kernel.org/doc/Documentation/gpio/sysfs.txt) is implemented. Being based on kernel implementation it's hardware agnostic and works on different boards without modification (this is on theory only, not all existing boards can be tested). The difference from other bindings dealing with GPIOs is that it works with GPIO subsystem on the board on which openHAB runs and doesn't require third-party programs/daemons running. The binding consists of two components: base module (org.openhab.io.gpio) which implements low-level GPIO access and provides API for high-level modules (can be used by other bindings needing to interact directly with GPIOs) and the binding itself (org.openhab.binding.gpio) which introduces hardware GPIO pins as full-featured openHAB items capable of generating events or receiving commands depending of their type (input or output). +This binding is for the local GPIO subsystem. It is currently only exposed to user space by [Linux GPIO framework](https://www.kernel.org/doc/Documentation/gpio/sysfs.txt). Being based on a kernel implementation, it's hardware agnostic and works on different boards without modification (this is on theory only, not all existing boards can be tested). + +The difference from other bindings dealing with GPIOs is that it works with GPIO subsystem on the board on which openHAB runs and doesn't require third-party programs/daemons running. The binding consists of two components: base module (org.openhab.io.gpio) which implements low-level GPIO access and provides API for high-level modules (can be used by other bindings needing to interact directly with GPIOs) and the binding itself (org.openhab.binding.gpio) which introduces hardware GPIO pins as full-featured openHAB items capable of generating events or receiving commands depending of their type (input or output). ## Prerequisites diff --git a/addons/bindings/oh1/harmonyhub/readme.md b/addons/bindings/oh1/harmonyhub/readme.md index 8367daacd..9103e3a84 100644 --- a/addons/bindings/oh1/harmonyhub/readme.md +++ b/addons/bindings/oh1/harmonyhub/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Harmony Hub - Bindings +source: external --- + {% include base.html %} @@ -8,7 +11,7 @@ layout: documentation The Harmony Hub binding is used to enable communication between openHAB and one or more 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. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/harmonyhub/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/harmonyhub/readme.html). ## Binding Configuration diff --git a/addons/bindings/oh1/hdanywhere/readme.md b/addons/bindings/oh1/hdanywhere/readme.md index eca554cbd..315ed8f88 100644 --- a/addons/bindings/oh1/hdanywhere/readme.md +++ b/addons/bindings/oh1/hdanywhere/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: HDanywhere - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/heatmiser/readme.md b/addons/bindings/oh1/heatmiser/readme.md index ac4ddd5eb..5df0823f8 100644 --- a/addons/bindings/oh1/heatmiser/readme.md +++ b/addons/bindings/oh1/heatmiser/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Heatmiser - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/hms/readme.md b/addons/bindings/oh1/hms/readme.md index 0633efa3c..a3c251d70 100644 --- a/addons/bindings/oh1/hms/readme.md +++ b/addons/bindings/oh1/hms/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: HMS - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/homematic/readme.md b/addons/bindings/oh1/homematic/readme.md index e62ac7663..7b2c5bb7f 100644 --- a/addons/bindings/oh1/homematic/readme.md +++ b/addons/bindings/oh1/homematic/readme.md @@ -1,11 +1,17 @@ --- layout: documentation +title: Homematic - Bindings +source: external --- + {% include base.html %} # Homematic Binding +This is the binding for the [eQ-3 Homematic Solution](http://www.eq-3.de/). +This binding allows you to integrate, view, control and configure all Homematic devices in the openHAB environment. + - RF and WIRED devices are supported - CCU/Homegear variables with synchronisation - execute programs on the CCU/Homegear @@ -84,7 +90,7 @@ These ports are used by the binding: The CCU firewall must be configured to 'full access' for the Remote Homematic-Script API. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/homematic/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/homematic/readme.html). ## Binding Configuration diff --git a/addons/bindings/oh1/horizon/readme.md b/addons/bindings/oh1/horizon/readme.md index 692ff7888..2fc985858 100644 --- a/addons/bindings/oh1/horizon/readme.md +++ b/addons/bindings/oh1/horizon/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Horizon mediabox - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/http/readme.md b/addons/bindings/oh1/http/readme.md index 094e379ff..23407625e 100644 --- a/addons/bindings/oh1/http/readme.md +++ b/addons/bindings/oh1/http/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: HTTP - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/hue/readme.md b/addons/bindings/oh1/hue/readme.md index 3fecb63d2..9270ce817 100644 --- a/addons/bindings/oh1/hue/readme.md +++ b/addons/bindings/oh1/hue/readme.md @@ -1,16 +1,21 @@ --- layout: documentation +title: Hue - Bindings +source: external --- + {% include base.html %} # Hue Binding +This binding connects openHAB to your Philips Hue lighting system. + Click the image below for a YouTube video demonstrating setup, configuration and a simple custom scene controller (openHAB 1, but still relevant to usage on openHAB 2). [![openHAB Hue binding](http://img.youtube.com/vi/Q4_LkXIRBWc/0.jpg)](http://www.youtube.com/watch?v=Q4_LkXIRBWc) -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/hue/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/hue/readme.html). ## Prerequisites diff --git a/addons/bindings/oh1/iec6205621meter/readme.md b/addons/bindings/oh1/iec6205621meter/readme.md index 40bf66169..57880e057 100644 --- a/addons/bindings/oh1/iec6205621meter/readme.md +++ b/addons/bindings/oh1/iec6205621meter/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: IEC 62056-21 Meter - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/ihc/readme.md b/addons/bindings/oh1/ihc/readme.md index 3b094e534..0464a6fd3 100644 --- a/addons/bindings/oh1/ihc/readme.md +++ b/addons/bindings/oh1/ihc/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: IHC / ELKO - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/insteonhub/readme.md b/addons/bindings/oh1/insteonhub/readme.md index 06b88d50d..0eacd07a0 100644 --- a/addons/bindings/oh1/insteonhub/readme.md +++ b/addons/bindings/oh1/insteonhub/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Insteon Hub - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/insteonplm/readme.md b/addons/bindings/oh1/insteonplm/readme.md index 0bbb0139a..137915e0b 100644 --- a/addons/bindings/oh1/insteonplm/readme.md +++ b/addons/bindings/oh1/insteonplm/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Insteon PLM - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/intertechno/readme.md b/addons/bindings/oh1/intertechno/readme.md index a54c1b81a..b99405d98 100644 --- a/addons/bindings/oh1/intertechno/readme.md +++ b/addons/bindings/oh1/intertechno/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Intertechno - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/ipx800/readme.md b/addons/bindings/oh1/ipx800/readme.md index 8afe74b33..05fe98701 100644 --- a/addons/bindings/oh1/ipx800/readme.md +++ b/addons/bindings/oh1/ipx800/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: IPX800 - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/irtrans/readme.md b/addons/bindings/oh1/irtrans/readme.md index 83872c06e..8d9c8bc39 100644 --- a/addons/bindings/oh1/irtrans/readme.md +++ b/addons/bindings/oh1/irtrans/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: IRTrans - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/jointspace/readme.md b/addons/bindings/oh1/jointspace/readme.md index 03d40dd6f..ce683959a 100644 --- a/addons/bindings/oh1/jointspace/readme.md +++ b/addons/bindings/oh1/jointspace/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: jointSPACE - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/k8055/readme.md b/addons/bindings/oh1/k8055/readme.md index f39a78a1f..f2d8c1c77 100644 --- a/addons/bindings/oh1/k8055/readme.md +++ b/addons/bindings/oh1/k8055/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Velleman k8055 USB IO Board - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/km200/readme.md b/addons/bindings/oh1/km200/readme.md index 37e2ad941..fe6651f9c 100644 --- a/addons/bindings/oh1/km200/readme.md +++ b/addons/bindings/oh1/km200/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: KM200 - Bindings +source: external --- + {% include base.html %} @@ -30,8 +33,8 @@ There are two different ways to configure the items. ### 1. Direct access with defined key ``` -DateTime budDate "Buderus Date Time[%1$tA, %1$td.%1$tm.%1$tY]" {km200="date_time"} -DateTime budDate "Buderus Datum [%1$td.%1$tm.%1$tY %1$tH:%1$tM]" {km200="date_time"} +DateTime budDate "Buderus Date Time [%1$tA, %1$td.%1$tm.%1$tY]" {km200="date_time"} +DateTime budDate "Buderus Datum [%1$td.%1$tm.%1$tY %1$tH:%1$tM]" {km200="date_time"} String budBrand "Brand of the heater [%s]" {km200="sys_brand"} String budType "Type of the heater [%s]" {km200="sys_type"} String budStatus "State of the heater [%s]" {km200="sys_state"} diff --git a/addons/bindings/oh1/knx/readme.md b/addons/bindings/oh1/knx/readme.md index 272c2c998..d4855e54f 100644 --- a/addons/bindings/oh1/knx/readme.md +++ b/addons/bindings/oh1/knx/readme.md @@ -1,10 +1,13 @@ --- layout: documentation +title: KNX - Bindings +source: external --- + {% include base.html %} -# KNX Binding (1.x) +# KNX Binding The openHAB KNX binding allows one 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. diff --git a/addons/bindings/oh1/koubachi/readme.md b/addons/bindings/oh1/koubachi/readme.md index 94f15cfe3..0762c8668 100644 --- a/addons/bindings/oh1/koubachi/readme.md +++ b/addons/bindings/oh1/koubachi/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Koubachi - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/lcn/readme.md b/addons/bindings/oh1/lcn/readme.md index 1e3a30e4c..2111c5065 100644 --- a/addons/bindings/oh1/lcn/readme.md +++ b/addons/bindings/oh1/lcn/readme.md @@ -1,14 +1,17 @@ --- layout: documentation +title: LCN - Bindings +source: external --- + {% include base.html %} # LCN Binding -![](http://3.bp.blogspot.com/-d5mm3HC7uic/VpO2ctrfWNI/AAAAAAAAJOI/a37JMGhC4IY/s600/openhab_lcn.jpg) +This binding connects to one or more LCN-PCHK instances via TCP/IP. **This means 1 unused LCN-PCHK license is required!** -The *openHAB LCN binding* connects to one or more LCN-PCHK instances via TCP/IP. **This means 1 unused LCN-PCHK license is required!** +![](http://3.bp.blogspot.com/-d5mm3HC7uic/VpO2ctrfWNI/AAAAAAAAJOI/a37JMGhC4IY/s600/openhab_lcn.jpg) The minimum recommended version is LCN-PCHK 2.8 (older versions will also work, but lack some functionality). Visit [http://www.lcn.de](http://www.lcn.de) for updates. diff --git a/addons/bindings/oh1/lgtv/readme.md b/addons/bindings/oh1/lgtv/readme.md index 2926d0688..ed6c4db99 100644 --- a/addons/bindings/oh1/lgtv/readme.md +++ b/addons/bindings/oh1/lgtv/readme.md @@ -1,14 +1,15 @@ --- layout: documentation +title: LG TV - Bindings +source: external --- + {% include base.html %} # LG TV Binding -* Every LG TV Model with Netcast 3.0 and Netcast 4.0 (Model years 2012 & 2013) -* Binding should be compatible with LG Tvs which support UDAP 2.0. protocol over Ethernet -http://developer.lgappstv.com/TV_HELP/topic/lge.tvsdk.references.book/html/UDAP/UDAP/UDAP%20Specifications%20For%20Second%20Screen%20TV%20and%20Companion%20Apps.htm +This binding supports LG TV models with Netcast 3.0 and Netcast 4.0 (Model years 2012 & 2013), and with LG TVs which support the UDAP 2.0 protocol over Ethernet. See ["UDAP Specifications (For Second Screen TV and Companion Apps)"](http://developer.lgappstv.com/TV_HELP/topic/lge.tvsdk.references.book/html/UDAP/UDAP/UDAP%20Specifications%20For%20Second%20Screen%20TV%20and%20Companion%20Apps.htm). Author: Martin Fluch 25.1.2014 diff --git a/addons/bindings/oh1/lightwaverf/readme.md b/addons/bindings/oh1/lightwaverf/readme.md index e74af964f..71afa2e94 100644 --- a/addons/bindings/oh1/lightwaverf/readme.md +++ b/addons/bindings/oh1/lightwaverf/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: LightwaveRF - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/mailcontrol/readme.md b/addons/bindings/oh1/mailcontrol/readme.md index 049c87a21..11e617625 100644 --- a/addons/bindings/oh1/mailcontrol/readme.md +++ b/addons/bindings/oh1/mailcontrol/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: MailControl - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/maxcube/readme.md b/addons/bindings/oh1/maxcube/readme.md index 23a51cb5e..6ad3c0ad7 100644 --- a/addons/bindings/oh1/maxcube/readme.md +++ b/addons/bindings/oh1/maxcube/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: MAX!Cube - Bindings +source: external --- + {% include base.html %} @@ -8,7 +11,7 @@ layout: documentation The MAX!Cube binding allows openHAB to connect to [(ELV) MAX!Cube Lan Gateway](http://www.elv.de/max-cube-lan-gateway.html) installations. The binding allows openHAB to communicate with the MAX! devices through the MAX!Cube Lan Gateway. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/max/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/max/readme.html). ## Prerequisites diff --git a/addons/bindings/oh1/maxcul/readme.md b/addons/bindings/oh1/maxcul/readme.md index 1753ffa1b..239b1eb4e 100644 --- a/addons/bindings/oh1/maxcul/readme.md +++ b/addons/bindings/oh1/maxcul/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: MAX!CUL - Bindings +source: external --- + {% include base.html %} @@ -10,7 +13,7 @@ The aim of this binding is to allow the connection from openHAB to MAX! devices A lot of credit must go to the [FHEM project](http://fhem.de/fhem.html): without their implementation of the MAX interface with CUL this would be taking a lot longer to implement! -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/max/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/max/readme.html). ## Status diff --git a/addons/bindings/oh1/mcp23017/readme.md b/addons/bindings/oh1/mcp23017/readme.md index a8b95f64d..b0ae3d621 100644 --- a/addons/bindings/oh1/mcp23017/readme.md +++ b/addons/bindings/oh1/mcp23017/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: MCP23017 - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/mcp3424/readme.md b/addons/bindings/oh1/mcp3424/readme.md index 27404992b..cb267653e 100644 --- a/addons/bindings/oh1/mcp3424/readme.md +++ b/addons/bindings/oh1/mcp3424/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: MCP3424 - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/milight/readme.md b/addons/bindings/oh1/milight/readme.md index b31d7fc96..6689b9274 100644 --- a/addons/bindings/oh1/milight/readme.md +++ b/addons/bindings/oh1/milight/readme.md @@ -1,16 +1,19 @@ --- layout: documentation +title: Milight - Bindings +source: external --- + {% include base.html %} -# Milight Binding (1.x) +# Milight Binding + +The Milight binding allows openHAB to send commands to multiple Milight bridges. [![openHAB Milight](http://img.youtube.com/vi/zNe9AkQbfmc/0.jpg)](http://www.youtube.com/watch?v=zNe9AkQbfmc) -The openHAB Milight binding allows to send commands to multiple Milight bridges. - -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/milight/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/milight/readme.html). ## Binding Configuration diff --git a/addons/bindings/oh1/mios/readme.md b/addons/bindings/oh1/mios/readme.md index 0edde7417..c774d98fe 100644 --- a/addons/bindings/oh1/mios/readme.md +++ b/addons/bindings/oh1/mios/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: MiOS Bridge - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/mochadx10/readme.md b/addons/bindings/oh1/mochadx10/readme.md index 6231e2cbf..de26ee2ef 100644 --- a/addons/bindings/oh1/mochadx10/readme.md +++ b/addons/bindings/oh1/mochadx10/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Mochad X10 - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/modbus/readme.md b/addons/bindings/oh1/modbus/readme.md index dbecd92cf..28d6777d0 100644 --- a/addons/bindings/oh1/modbus/readme.md +++ b/addons/bindings/oh1/modbus/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Modbus - Bindings +source: external --- + {% include base.html %} @@ -10,8 +13,8 @@ The binding supports both TCP and Serial slaves. RTU, ASCII and BIN variants of The binding can act as -- Modbus TCP Client (that is, as modbus master), querying data from Modbus TCP servers (that is, modbus slaves). -- Modbus serial master, querying data from modbus serial slaves +* Modbus TCP Client (that is, as modbus master), querying data from Modbus TCP servers (that is, modbus slaves). +* Modbus serial master, querying data from modbus serial slaves The Modbus binding polls the slaves with an configurable poll period. openHAB commands are translated to write requests. @@ -63,7 +66,9 @@ The configuration parameters have the following pattern: ```ini ..= ``` -where + +where: + - `` can be either "tcp" or "serial" depending on the type of this Modbus slave - `` is unique name per slave you are connecting to. Used in openHAB configuration to refer to the slave. - `` identifies the parameter to configure @@ -71,7 +76,6 @@ where Valid slave parameters are - @@ -83,6 +87,7 @@ Valid slave parameters are port refers to COM port name on Windows and serial device path in *nix. Optionally one can configure one or more of the serial parameters: baud (default 9600), dataBits (default 8), parity (default none), stopBits (default 1), encoding (default ascii).
Options for the optional serial parameters are as follows: parity={even, odd}; encoding={ascii, rtu, bin}.

See also below for additional connection parameters introduced in 1.9.0. + @@ -154,6 +159,7 @@ There are three ways to bind an item to modbus coils/registers. ```ini Switch MySwitch "My Modbus Switch" (ALL) {modbus="slave1:5"} ``` + - This binds MySwitch to modbus slave defined as "slave1" in `modbus.cfg` reading/writing to the coil (5 + slave's `start` index). The `5` is called item read index. - If the slave is read-only, that is the `type` is `input` or `discrete`, the binding ignores any write commands. - if the slave1 refers to registers, and after parsing using the registers as rules defined by the `valuetype`, zero value is considered as `OFF`, everything else as `ON`. @@ -175,6 +181,7 @@ Contact Contact1 "Contact1 [MAP(en.map):%s]" (All) {modbus="slave2:0"} - In this case regarding to moxa example coil 0 is used as discrete input (in Moxa naming DI-00) - (?) following examples are relatively useless, if you know better one let us know! + counter values in most cases 16bit values, now we must do math: in rules to deal with them ... ### Read / write register (number) @@ -188,6 +195,7 @@ and in sitemap you can for example ```ini Setpoint item=Dimmer1 minValue=0 maxValue=100 step=5 ``` + **NOTE:** if the item value goes over the max value specified by the `valuetype` (e.g. 32767 with `int16`), the effects are fully untested!!! (?) this example should write the value to all DO bits of an moxa e1212 as byte value @@ -217,10 +225,10 @@ Number MyCounter "My Counter [%f]" (All) {modbus="slave5:0"}` # Details - ## Modbus functions supported ### Supported Modbus object types + Modbus binding allows to connect to multiple Modbus slaves. The binding supports following Modbus *object types* - coils, also known as *digital out (DO)* (read & write) @@ -250,6 +258,7 @@ The binding uses following function codes when communicating with the slaves: ## Comment on addressing + [Modbus Wikipedia article](https://en.wikipedia.org/wiki/Modbus#Coil.2C_discrete_input.2C_input_register.2C_holding_register_numbers_and_addresses) summarizes this excellently: > In the traditional standard, [entity] numbers for those entities start with a digit, followed by a number of four digits in range 1–9,999: @@ -282,13 +291,16 @@ Please note that the binding requires that all slaves connecting to the same ser Similarly, one must have identical connection parameters for all tcp slaves connecting to same host+port. ## Read and write functions (modbus slave type) + Modbus read functions + - `type=coil` uses function 1 "Read Coil Status" - `type=discrete` uses function 2 "Read Input Status" (readonly inputs) - `type=holding` uses function 3, "Read Holding Registers" - `type=input` uses function 4 "Read Input Register" (readonly-registers eG analogue inputs) Modbus write functions + - `type=coil` uses function 5 "Write Single Coil" - `type=holding` uses function 6 "Write Single Register", or function 16 "Write Multiple registers" when `writemultipleregisters` is `true` @@ -312,43 +324,53 @@ The logic for converting read registers to number goes as below. Different proce Note that first register refers to register with address `start` (as defined in the slave definition), second register refers to register with address `start + 1` etc. The index refers to item read index, e.g. item `Switch MySwitch "My Modbus Switch" (ALL) {modbus="slave1:5"}` has 5 as read index. `valuetype=bit`: + - a single bit is read from the registers - indices between 0...15 (inclusive) represent bits of the first register - indices between 16...31 (inclusive) represent bits of the second register, etc. - index 0 refers to the least significant bit of the first register - index 1 refers to the second least significant bit of the first register, etc. + (Note that updating a bit in a holding type register will NOT work as expected across Modbus, the whole register gets rewritten. Best to use a read-only mode, such as Contact item. Input type registers are by definition read-only.) `valuetype=int8`: + - a byte (8 bits) from the registers is interpreted as signed integer - index 0 refers to low byte of the first register, 1 high byte of first register - index 2 refers to low byte of the second register, 3 high byte of second register, etc. - it is assumed that each high and low byte is encoded in most significant bit first order `valuetype=uint8`: + - same as `int8` except values are interpreted as unsigned integers `valuetype=int16`: + - register with index (counting from zero) is interpreted as 16 bit signed integer. - it is assumed that each register is encoded in most significant bit first order `valuetype=uint16`: + - same as `int16` except values are interpreted as unsigned integers `valuetype=int32`: + - registers (2 index) and ( 2 *index + 1) are interpreted as signed 32bit integer. - it assumed that the first register contains the most significant 16 bits - it is assumed that each register is encoded in most significant bit first order `valuetype=uint32`: + - same as `int32` except values are interpreted as unsigned integers `valuetype=float32`: + - registers (2 index) and ( 2 *index + 1) are interpreted as signed 32bit floating point number. - it assumed that the first register contains the most significant 16 bits - it is assumed that each register is encoded in most significant bit first order #### Word Swapped valuetypes (New since 1.9.0) + The MODBUS specification defines each 16bit word to be encoded as Big Endian, but there is no specification on the order of those words within 32bit or larger data types. The net result is that when you have a master and slave that operate with the same @@ -359,20 +381,24 @@ that have the words swapped. If you get strange values using the int32, uint32 or float32 valuetypes then just try the int32_swap, uint32_swap or float32_swap valuetype, depending upon what your data type is. `valuetype=int32_swap`: + - registers (2 index) and ( 2 *index + 1) are interpreted as signed 32bit integer. - it assumed that the first register contains the least significant 16 bits - it is assumed that each register is encoded in most significant bit first order (Big Endian) `valuetype=uint32_swap`: + - same as `int32_swap` except values are interpreted as unsigned integers `valuetype=float32_swap`: + - registers (2 index) and ( 2 *index + 1) are interpreted as signed 32bit floating point number. - it assumed that the first register contains the least significant 16 bits - it is assumed that each register is encoded in most significant bit first order (Big Endian) #### Extra notes + - `valuetypes` smaller than one register (less than 16 bits) actually read the whole register, and finally extract single bit from the result. ### Write @@ -384,6 +410,7 @@ When the binding processes openhab command (e.g. sent by `sendCommand` as explai 3. the 16bits are written to the register with address `start` (as defined in the slave definition) Conversion rules for converting command to 16bit integer + - UP, ON, OPEN commands that are converter to number 1 - DOWN, OFF, CLOSED commands are converted to number 0 - Decimal commands are truncated as 32 bit integer (in 2's complement representation), and then the least significant 16 bits of this integer are extracted. @@ -391,12 +418,14 @@ Conversion rules for converting command to 16bit integer **Note: The way Decimal commands are handled currently means that it is probably not useful to try to use Decimal commands with non-16bit `valuetype`s.** Converting INCREASE and DECREASE commands to numbers is more complicated + 1. Register matching (`start` + read index) is interpreted as unsigned 16bit integer. Previous polled register value is used 2. add/subtract `1` from the integer **Note: note that INCREASE and DECREASE ignore valuetype when using the previously polled value. Thus, it is not recommended to use INCREASE and DECREASE commands with other than `valuetype=uint16`** ### Modbus RTU over TCP + Some devices uses modbus RTU over TCP. This is usually Modbus RTU encapsulation in an ethernet packet. So, those devices does not work with Modbus TCP binding since it is Modbus with a special header. Also Modbus RTU over TCP is not supported by Openhab Modbus Binding. But there is a workaround: you can use a Virtual Serial Port Server, to emulate a COM Port and Bind it with OpenHab unsing Modbus Serial. @@ -493,7 +522,6 @@ tcp.slave5.valuetype=float32 Above we used the same modbus gateway with ip 192.168.6.180 multiple times on different modbus address ranges and modbus functions. - # Troubleshooting ## Enable verbose logging @@ -511,14 +539,19 @@ You can use test serial slaves without any hardware on linux using these steps: 1. Set-up virtual null modem emulator using [tty0tty](https://github.com/freemed/tty0tty) 2. Download [diagslave](http://www.modbusdriver.com/diagslave.html) and start modbus serial slave up using this command: + ``` ./diagslave -m rtu -a 1 -b 38400 -d 8 -s 1 -p none -4 10 /dev/pts/7 ``` + 3. Configure openhab's modbus slave to connect to `/dev/pts/8`: + ```ini xxx.connection=/dev/pts/8:38400:8:none:1:rtu ``` + 4. Modify `start.sh` or `start_debug.sh` to include the unconventional port name by adding the following argument to `java`: + ``` -Dgnu.io.rxtx.SerialPorts=/dev/pts/8 ``` @@ -528,10 +561,13 @@ Naturally this is not the same thing as the real thing but helps to identify sim ## Testing TCP implementation 1. Download [diagslave](http://www.modbusdriver.com/diagslave.html) and start modbus tcp server (slave) using this command: + ``` ./diagslave -m tcp -a 1 -p 55502 ``` + 2. Configure openhab's modbus slave to connect to `127.0.0.1:55502`: + ```ini tcp.slave1.connection=127.0.0.1:55502 ``` @@ -653,8 +689,6 @@ tcp.slave1.length=20 tcp.slave1.postundefinedonreaderror=true ``` -As inspiration I used [Roller shutter wiki page](https://github.com/openhab/openhab/wiki/Rollershutter-Bindings) +As inspiration I used [Roller shutter wiki page](https://github.com/openhab/openhab1-addons/wiki/Rollershutter-Bindings) [Table of Contents](#table-of-contents) - -See [Modbus Binding](https://github.com/openhab/openhab/wiki/Modbus-Binding) \ No newline at end of file diff --git a/addons/bindings/oh1/mpd/readme.md b/addons/bindings/oh1/mpd/readme.md index 182f87d00..18b45b267 100644 --- a/addons/bindings/oh1/mpd/readme.md +++ b/addons/bindings/oh1/mpd/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: MPD - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/mqtt/readme.md b/addons/bindings/oh1/mqtt/readme.md index 5434d3245..0b382e8ff 100644 --- a/addons/bindings/oh1/mqtt/readme.md +++ b/addons/bindings/oh1/mqtt/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: MQTT - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/mqttitude/readme.md b/addons/bindings/oh1/mqttitude/readme.md index 8fcf0c98e..5abd55a53 100644 --- a/addons/bindings/oh1/mqttitude/readme.md +++ b/addons/bindings/oh1/mqttitude/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: OwnTracks (formerly MQTTitude) - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/myq/readme.md b/addons/bindings/oh1/myq/readme.md index 01f49f4aa..d28476106 100644 --- a/addons/bindings/oh1/myq/readme.md +++ b/addons/bindings/oh1/myq/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Chamberlain MyQ - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/mystromecopower/readme.md b/addons/bindings/oh1/mystromecopower/readme.md index 891be7430..af3e5c84d 100644 --- a/addons/bindings/oh1/mystromecopower/readme.md +++ b/addons/bindings/oh1/mystromecopower/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Mystrom Eco Power - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/neohub/readme.md b/addons/bindings/oh1/neohub/readme.md index 43b84a5aa..202b93666 100644 --- a/addons/bindings/oh1/neohub/readme.md +++ b/addons/bindings/oh1/neohub/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: NeoHub - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/nest/readme.md b/addons/bindings/oh1/nest/readme.md index 6ea4caf6a..f7c1f7835 100644 --- a/addons/bindings/oh1/nest/readme.md +++ b/addons/bindings/oh1/nest/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Nest - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/netatmo/readme.md b/addons/bindings/oh1/netatmo/readme.md index a59c1b56c..f6032cc5f 100644 --- a/addons/bindings/oh1/netatmo/readme.md +++ b/addons/bindings/oh1/netatmo/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Netatmo - Bindings +source: external --- + {% include base.html %} @@ -10,7 +13,7 @@ The Netatmo binding integrates the Netatmo Personal Weather Station into openHAB The Netatmo Welcome Camera is also supported; it is a home camera with face recognition. It notifies you when it sees someone it knows, but also when it sees a stranger. See information below to obtain the necessary informations to setup your Netatmo Gear, also see [the Netatmo website](http://www.netatmo.com/) for details on their products. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/netatmo/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/netatmo/readme.html). > The Netatmo Binding (1.x) is considered a legacy binding and does not show up by default as an add-on in the OpenHAB 2 Paper UI. In order for the binding to show up as a add-on, you need to go to Configuration->System and enable both **Access Remote Repositories** and **Include Legacy 1.x Bindings** and save the setting. Once you have done this, you will see both **Netatmo Binding** and **Netatmo Binding (1.x)** in Add-ons, you will want to install **Netatmo Binding**. diff --git a/addons/bindings/oh1/networkhealth/readme.md b/addons/bindings/oh1/networkhealth/readme.md index d81a20834..9576682da 100644 --- a/addons/bindings/oh1/networkhealth/readme.md +++ b/addons/bindings/oh1/networkhealth/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Network Health - Bindings +source: external --- + {% include base.html %} @@ -8,7 +11,7 @@ layout: documentation This binding allows openHAB to check whether a device is currently available on the network. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/network/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/network/readme.html). ## Binding Configuration diff --git a/addons/bindings/oh1/networkupstools/readme.md b/addons/bindings/oh1/networkupstools/readme.md index 0d26de707..5a9a51c4e 100644 --- a/addons/bindings/oh1/networkupstools/readme.md +++ b/addons/bindings/oh1/networkupstools/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Network UPS Tools - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/nibeheatpump/readme.md b/addons/bindings/oh1/nibeheatpump/readme.md index ae9d193d1..3315a80d3 100644 --- a/addons/bindings/oh1/nibeheatpump/readme.md +++ b/addons/bindings/oh1/nibeheatpump/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Nibe Heatpump - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/nikobus/readme.md b/addons/bindings/oh1/nikobus/readme.md index 98698bbaf..1ecdeb6a9 100644 --- a/addons/bindings/oh1/nikobus/readme.md +++ b/addons/bindings/oh1/nikobus/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Nikobus - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/novelanheatpump/readme.md b/addons/bindings/oh1/novelanheatpump/readme.md index 87d623a9c..946a5ae81 100644 --- a/addons/bindings/oh1/novelanheatpump/readme.md +++ b/addons/bindings/oh1/novelanheatpump/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Novelan/Luxtronic Heat Pump - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/ntp/readme.md b/addons/bindings/oh1/ntp/readme.md index 71c3cdc80..75b5622fc 100644 --- a/addons/bindings/oh1/ntp/readme.md +++ b/addons/bindings/oh1/ntp/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Network Time Protocol (NTP) - Bindings +source: external --- + {% include base.html %} @@ -8,7 +11,7 @@ layout: documentation The [Network Time Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) Binding is used to query an NTP server you configure for the current time, within tens of milliseconds of accurary. Items in openHAB will receive these updates. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/ntp/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/ntp/readme.html). ## Binding Configuration diff --git a/addons/bindings/oh1/omnilink/readme.md b/addons/bindings/oh1/omnilink/readme.md index 7de0927b1..b94ffb755 100644 --- a/addons/bindings/oh1/omnilink/readme.md +++ b/addons/bindings/oh1/omnilink/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: HAI/Leviton Omni and Lumina - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/onewire/readme.md b/addons/bindings/oh1/onewire/readme.md index ce64a0222..537932c03 100644 --- a/addons/bindings/oh1/onewire/readme.md +++ b/addons/bindings/oh1/onewire/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: OneWire - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/onkyo/readme.md b/addons/bindings/oh1/onkyo/readme.md index a93ec7ac2..2e2567a24 100644 --- a/addons/bindings/oh1/onkyo/readme.md +++ b/addons/bindings/oh1/onkyo/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Onkyo AV Receiver - Bindings +source: external --- + {% include base.html %} @@ -8,7 +11,7 @@ layout: documentation This binding is compatible with Onkyo AV receivers which support ISCP (Integra Serial Control Protocol) over Ethernet (eISCP) and serial ports. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/onkyo/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/onkyo/readme.html). ## Binding Configuration diff --git a/addons/bindings/oh1/openenergymonitor/readme.md b/addons/bindings/oh1/openenergymonitor/readme.md index 4079f21ff..8041af62c 100644 --- a/addons/bindings/oh1/openenergymonitor/readme.md +++ b/addons/bindings/oh1/openenergymonitor/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Open Energy Monitor - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/openpaths/readme.md b/addons/bindings/oh1/openpaths/readme.md index aa976f748..51cfc53e6 100644 --- a/addons/bindings/oh1/openpaths/readme.md +++ b/addons/bindings/oh1/openpaths/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: OpenPaths - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/opensprinkler/readme.md b/addons/bindings/oh1/opensprinkler/readme.md index 00b26de31..72796e7b4 100644 --- a/addons/bindings/oh1/opensprinkler/readme.md +++ b/addons/bindings/oh1/opensprinkler/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: OpenSprinkler - Bindings +source: external --- + {% include base.html %} @@ -12,7 +15,7 @@ This binding is compatible with with both the [OpenSprinkler](http://opensprinkl The binding will sync itself with the OpenSprinkler device at intervals. This allows state of the stations to be updated if they are manually controlled from the OpenSprinkler web application directly. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/opensprinkler/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/opensprinkler/readme.html). ## Prerequisites diff --git a/addons/bindings/oh1/owserver/readme.md b/addons/bindings/oh1/owserver/readme.md index b52507277..5566031e2 100644 --- a/addons/bindings/oh1/owserver/readme.md +++ b/addons/bindings/oh1/owserver/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: OWServer - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/panasonictv/readme.md b/addons/bindings/oh1/panasonictv/readme.md index 17726d457..0c915fd8d 100644 --- a/addons/bindings/oh1/panasonictv/readme.md +++ b/addons/bindings/oh1/panasonictv/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Panasonic TV - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/panstamp/readme.md b/addons/bindings/oh1/panstamp/readme.md index e405383ce..322745499 100644 --- a/addons/bindings/oh1/panstamp/readme.md +++ b/addons/bindings/oh1/panstamp/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: panStamp - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/piface/readme.md b/addons/bindings/oh1/piface/readme.md index 4a8a9ec75..853509db0 100644 --- a/addons/bindings/oh1/piface/readme.md +++ b/addons/bindings/oh1/piface/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Piface - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/pilight/readme.md b/addons/bindings/oh1/pilight/readme.md index 4c9ae2b54..2226ba0f6 100644 --- a/addons/bindings/oh1/pilight/readme.md +++ b/addons/bindings/oh1/pilight/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: pilight - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/pioneeravr/readme.md b/addons/bindings/oh1/pioneeravr/readme.md index 26b5715f9..0076ea65d 100644 --- a/addons/bindings/oh1/pioneeravr/readme.md +++ b/addons/bindings/oh1/pioneeravr/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Pioneer AV Receiver (1.x) - Bindings +source: external --- + {% include base.html %} @@ -10,7 +13,7 @@ This binding allows openHAB to remotely control a Pioneer AV receiver equipped w Most common commands are supported directly, special commands can be added manually using the "advanced command" mechanism described below. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/pioneeravr/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/pioneeravr/readme.html). ## Binding configuration diff --git a/addons/bindings/oh1/plcbus/readme.md b/addons/bindings/oh1/plcbus/readme.md index 3774e9dab..8b4e96edd 100644 --- a/addons/bindings/oh1/plcbus/readme.md +++ b/addons/bindings/oh1/plcbus/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: PLCBus - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/plclogo/readme.md b/addons/bindings/oh1/plclogo/readme.md index 925499146..0b573e669 100644 --- a/addons/bindings/oh1/plclogo/readme.md +++ b/addons/bindings/oh1/plclogo/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: PLCLogo - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/plex/readme.md b/addons/bindings/oh1/plex/readme.md index 60e7ded84..bd93ea431 100644 --- a/addons/bindings/oh1/plex/readme.md +++ b/addons/bindings/oh1/plex/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Plex - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/plugwise/readme.md b/addons/bindings/oh1/plugwise/readme.md index 7ebb97f55..6bd07b0a5 100644 --- a/addons/bindings/oh1/plugwise/readme.md +++ b/addons/bindings/oh1/plugwise/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Plugwise - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/powerdoglocalapi/readme.md b/addons/bindings/oh1/powerdoglocalapi/readme.md index 3e9f60457..2eacbbb45 100644 --- a/addons/bindings/oh1/powerdoglocalapi/readme.md +++ b/addons/bindings/oh1/powerdoglocalapi/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: PowerDog Local API - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/powermax/readme.md b/addons/bindings/oh1/powermax/readme.md index c7f6f0477..5a5fcb881 100644 --- a/addons/bindings/oh1/powermax/readme.md +++ b/addons/bindings/oh1/powermax/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Visonic Powermax - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/primare/readme.md b/addons/bindings/oh1/primare/readme.md index 4c6a3d495..fe550df28 100644 --- a/addons/bindings/oh1/primare/readme.md +++ b/addons/bindings/oh1/primare/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Primare - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/pulseaudio/readme.md b/addons/bindings/oh1/pulseaudio/readme.md index fe6b4ee13..939b03055 100644 --- a/addons/bindings/oh1/pulseaudio/readme.md +++ b/addons/bindings/oh1/pulseaudio/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Pulseaudio - Bindings +source: external --- + {% include base.html %} @@ -8,7 +11,7 @@ layout: documentation This binding allows openHAB to monitor and control pulseaudio servers. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/pulseaudio/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/pulseaudio/readme.html). ## Prerequisites diff --git a/addons/bindings/oh1/rfxcom/readme.md b/addons/bindings/oh1/rfxcom/readme.md index 02a5b643f..2a05fcaad 100644 --- a/addons/bindings/oh1/rfxcom/readme.md +++ b/addons/bindings/oh1/rfxcom/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: RFXCOM - Bindings +source: external --- + {% include base.html %} @@ -34,7 +37,7 @@ The RFXCOM binding currently supports the following packet types: * Transmitter * Wind -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/rfxcom/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/rfxcom/readme.html). ## Table of Contents diff --git a/addons/bindings/oh1/rpircswitch/readme.md b/addons/bindings/oh1/rpircswitch/readme.md index e3128e8ea..e73275d16 100644 --- a/addons/bindings/oh1/rpircswitch/readme.md +++ b/addons/bindings/oh1/rpircswitch/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Raspberry Pi RC Switch - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/rwesmarthome/readme.md b/addons/bindings/oh1/rwesmarthome/readme.md index 6b4a96c95..dc634d51a 100644 --- a/addons/bindings/oh1/rwesmarthome/readme.md +++ b/addons/bindings/oh1/rwesmarthome/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: RWE SmartHome - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/sagercaster/readme.md b/addons/bindings/oh1/sagercaster/readme.md index b2839e99e..d7e4b147a 100644 --- a/addons/bindings/oh1/sagercaster/readme.md +++ b/addons/bindings/oh1/sagercaster/readme.md @@ -1,12 +1,15 @@ --- layout: documentation +title: Sager Weathercaster - Bindings +source: external --- + {% include base.html %} # Sager Weathercaster Binding -The Sager Weathercaster is a scientific instrument for accurate prediction of the weather. +The Sager Weathercaster is a scientific instrument for accurate prediction of the weather. **This binding is currently incompatible with openHAB 2.** ## Limitations diff --git a/addons/bindings/oh1/sallegra/readme.md b/addons/bindings/oh1/sallegra/readme.md index 68976fb3b..39e49b7a2 100644 --- a/addons/bindings/oh1/sallegra/readme.md +++ b/addons/bindings/oh1/sallegra/readme.md @@ -1,15 +1,17 @@ --- layout: documentation +title: Sallegra - Bindings +source: external --- + {% include base.html %} # Sallegra Binding -The Sallegra binding supports the following devices: +The Sallegra binding supports the Sallegra Dimmer DA-ET-4, Sallegra Relay R-ET-4 and Sallegra Input ADI-ET-8/8. -* Sallegra Dimmer DA-ET-4, Sallegra Relay R-ET-4 and Sallegra Input ADI-ET-8/8 are currently supported -* Syncs the openHAB status with the actual status on the Sallegra Module +This binding syncs the openHAB status with the actual status on the Sallegra Module. ## Prerequisites diff --git a/addons/bindings/oh1/samsungac/readme.md b/addons/bindings/oh1/samsungac/readme.md index 039b5abde..cee9112c1 100644 --- a/addons/bindings/oh1/samsungac/readme.md +++ b/addons/bindings/oh1/samsungac/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Samsung Air Conditioner - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/samsungtv/readme.md b/addons/bindings/oh1/samsungtv/readme.md index fe20ebe24..37835b9ae 100644 --- a/addons/bindings/oh1/samsungtv/readme.md +++ b/addons/bindings/oh1/samsungtv/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Samsung TV - Bindings +source: external --- + {% include base.html %} @@ -14,7 +17,7 @@ This binding should be compatible with Samsung TV models which support Apple and * The KEY_POWERON command does not switch the TV on. Tested on Samsung UE40ES5700, maybe other models are working. * New models (H-Series TV´s like e.g. UEH5570 ) use a different (encrypted) protocol; they are not yet supported by this binding. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/samsungtv/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/samsungtv/readme.html). ## Binding Configuration diff --git a/addons/bindings/oh1/sapp/readme.md b/addons/bindings/oh1/sapp/readme.md index e9a4bb695..e107055ae 100644 --- a/addons/bindings/oh1/sapp/readme.md +++ b/addons/bindings/oh1/sapp/readme.md @@ -1,12 +1,210 @@ --- layout: documentation +title: Picnet Sapp - Bindings +source: external --- + {% include base.html %} -# Sapp Binding +# Picnet Sapp Binding + +The openHAB Sapp binding connects to [Picnet](http://www.sinthesi.com) Home Automation installations. The binding supports multi master configuration as well. + +The Sapp binding polls the bus in an configurable interval and support sapp over ethernet only, so if you use an old master series without ethernet connection you need to use a Moxa 5110 in order to use it. + +## Binding Configuration + +This binding can be configured with the file `services/sapp.cfg`. + +| Property | Default | Required | Description | +|----------|---------|:--------:|-------------| +| refresh | 100 | No | refresh interval to Picnet polling service. Value is in milliseconds. | +| pnmas.ids=home,office | | Yes | Examples: `home,office` | +| pnmas.``.ip | | Yes | Only the pnmas listed in `pnmas.ids` are used | +| pnmas.``.port | | Yes | Only the pnmas listed in `pnmas.ids` are used. Example: `7001` | + +where: + +* `` is a name you choose for an instance to control. You can specify multiple values for ``.ip and ``.port. + + +### Example sapp.cfg + +``` +refresh=100 +pnmas.ids=home,work +pnmas.home.ip=192.168.2.97 +pnmas.home.port=7001 +pnmas.work.ip=192.168.2.98 +pnmas.work.port=4001 +``` + +## Item Configuration + +The Picnet Master supports Input Output and Virtual address types. + +In the binding we use: + +***pnmasid status*** + +It is the `pnmas.ids` name defined in binding configuration. + +***Status address type*** + +These values are accepted in order to get the status + +* **`I`**: Input (valid numbers are from 1 to 250). This is the module address +* **`O`**: Output (valid numbers are from 1 to 250). This is the module address +* **`V`**: Virtual (valid numbers are from 1 to 2500). This is the virtual number + +***Status address*** + +It is a number and its value depends from the Status address type as described. + +***Status subaddress*** + +These values are accepted in order to get the status + +* **`*`**: The word value +* **`H`**: The high byte value +* **`L`**: The low byte value +* **`1-16`**: The single bit value +* **`+`**: Signed word, -32768 to 32767 +* **`H+`**: Signed high byte, -128 to 127 +* **`L+`**: Signed low byte, -128 to 127 + +***Control address type*** + +This values are accepted in order to control the status. Only Virtual is accepted. + +* **`V`**: Virtual valid numbers are from 1 to 2500. This is the virtual number + +***Control address*** + +It is a number and the value depends from the Status address type as described. + +***Control subaddress*** + +These values are accepted in order to control the status + +* **`*`**: The word value +* **`H`**: The high byte value +* **`L`**: The low byte value +* **`1-16`**: The single bit value +* **`+`**: Signed word, -32768 to 32767 +* **`H+`**: Signed high byte, -128 to 127 +* **`L+`**: Signed low byte, -128 to 127 + +The sapp binding support the following items and their use is listed here: + +### Switch + +Switch item syntax: + +``` +::::/::::: +``` + +#### Switch Example + +In this example we control the status of module 60 Output 1 and we control it using Virtual 2001 bit 1 and we send 1 on ON and 1 on OFF command. +The Virtual 2001 is autoreset type on master program. + +``` +Switch LightDinner "Dinner Light" (gLight) { sapp="home:O:60:1/home:V:2001:1:1:1" } +``` + +***How to start and stop polling using a switch item*** + +There is a special switch that can stop and start polling in order to write the Master without stopping Openhab sw. + +`Switch PollerSwitch "PollerSwitch" { sapp="P" }` + +### Contact + +Contact item syntax: + +``` +// :::: +``` + +#### Contact Example + +In this example we control the status of module 12 Input 7. + +``` +Contact ContactWindowsBath "Bath Window" { sapp="home:I:12:7" } +``` + +The contact status is by default inverted, so NC contact for is OPEN and NO is CLOSED. To invert the status just add :0 at the end of the string just like the example: + +``` +Contact ContactWindowsBath "Bath Window" { sapp="home:I:12:7:0" } +``` + +### Number + +Number item syntax: + +``` +::: +``` + +#### Number Examples + +Number item come with scale system included. For example in order to scale a word value /10 you can use :0:6553 like example. Default scale depends on address type (0-65535 for word, 0-255 for L/H, 0-1 for bit). + +``` +Number SappNumber1 "Sapp Number * : Value [%.1f]" { sapp="home:V:200:*:1:1000" } +Number SappNumber2 "Sapp Number H : Value [%.1f]" { sapp="home:V:200:H:0:2500" } +Number SappNumber3 "Sapp Number L : Value [%.1f]" { sapp="home:V:200:L" } +Number SappNumber4 "Sapp Number 1 : Value [%.1f]" { sapp="home:V:200:1" } +Number SappNumber5 "Sapp Number 2 : Value [%.1f]" { sapp="home:V:200:2" } +Number SappNumberX1 "Sapp Number Setpoint : Value [%.1f]" { sapp="home:V:230:*:0:6553" } +Number SappNumberX2 "Sapp Number Setpoint : Value [%.1f]" { sapp="home:V:230:*" } +``` + +### Rollershutter + +Rollershutter item syntax: + +``` +:::::/::::/::::/:::: +``` + +#### Rollershutter Example + +In this example we control the status of Virtual 154 from 0 to 100 for percent status. Virtual 155 bit 1 is used for up command, Virtual 155 bit 2 is used for stop command, Virtual 155 bit 3 is used for down command. + +``` +Rollershutter BlindBath "Bath Blind" { sapp="home:V:154:*:0:100/home:V:155:1:1/home:V:155:2:1/home:V:155:3:1" } +``` +### Dimmer + +Dimmer item syntax: + +``` +:::: +``` + +#### Dimmer Examples + +Dimmer item come with scale system included; use L or H in order to scale from 0 to 255 and * in order to scale from 0 to 65535. Here Virtual 25 has value from 0 to 255 with step to 10 + +``` +Dimmer dimmer1 "dimmer [%d %%]" (gSapp1) { sapp="home:V:25:L:10" } +``` + +If you want to use dimmer in sitemap you can use this definitions: + +``` +Switch item=dimmer1 mappings=[INCREASE="+",DECREASE="-", ON="ON", OFF="OFF"] +Switch item=dimmer1 mappings=[0="OFF", 25="25", 50="50", 75="75", 100="100"] +Slider item=dimmer1 sendFrequency=100 switchSupport +``` ## Implementation Notes -The default OpenHAB code formatter has been modified in this binding just in the "maximum line width" parameter, allowing longer lines then the standard OpenHAB. -This is because the code would otherwise be quite unreadable being split over too many lines. \ No newline at end of file +The default openHAB code formatter has been modified in this binding just in the "maximum line width" parameter, allowing longer lines then the standard openHAB. +This is because the code would otherwise be quite unreadable being split over too many lines. diff --git a/addons/bindings/oh1/satel/readme.md b/addons/bindings/oh1/satel/readme.md index 1d3c259da..3c218251f 100644 --- a/addons/bindings/oh1/satel/readme.md +++ b/addons/bindings/oh1/satel/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Satel Integra Alarm System - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/serial/readme.md b/addons/bindings/oh1/serial/readme.md index 354c13cb8..aa3a01a1c 100644 --- a/addons/bindings/oh1/serial/readme.md +++ b/addons/bindings/oh1/serial/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Serial - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/smarthomatic/readme.md b/addons/bindings/oh1/smarthomatic/readme.md index 82cf629cf..eebad862c 100644 --- a/addons/bindings/oh1/smarthomatic/readme.md +++ b/addons/bindings/oh1/smarthomatic/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Smarthomatic - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/snmp/readme.md b/addons/bindings/oh1/snmp/readme.md index bf09e42ad..84e6284da 100644 --- a/addons/bindings/oh1/snmp/readme.md +++ b/addons/bindings/oh1/snmp/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: SNMP - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/sonance/readme.md b/addons/bindings/oh1/sonance/readme.md index e7f0748dd..ce2fc3e24 100644 --- a/addons/bindings/oh1/sonance/readme.md +++ b/addons/bindings/oh1/sonance/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Sonance - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/sonos/readme.md b/addons/bindings/oh1/sonos/readme.md index 89ade4cba..c2ae7850a 100644 --- a/addons/bindings/oh1/sonos/readme.md +++ b/addons/bindings/oh1/sonos/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Sonos - Bindings +source: external --- + {% include base.html %} @@ -12,7 +15,7 @@ Sonos Players support multi-room audio. Sonos achieves this by grouping Sonos Pl Sonos Players also support playlists, music streaming services like Spotify, Rapsody, … as well as alarm clocks that you can program to wake up with your favourite music -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/sonos/readme.html). That binding can discover your Sonos players and therefore does not need you to learn UDNs through alternate means. +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/sonos/readme.html). That binding can discover your Sonos players and therefore does not need you to learn UDNs through alternate means. ## Limitations diff --git a/addons/bindings/oh1/souliss/readme.md b/addons/bindings/oh1/souliss/readme.md index de1c8fe5b..583a9ea73 100644 --- a/addons/bindings/oh1/souliss/readme.md +++ b/addons/bindings/oh1/souliss/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Souliss - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/squeezebox/readme.md b/addons/bindings/oh1/squeezebox/readme.md index 653f2300d..bad3ae2c2 100644 --- a/addons/bindings/oh1/squeezebox/readme.md +++ b/addons/bindings/oh1/squeezebox/readme.md @@ -1,11 +1,15 @@ --- layout: documentation +title: Squeezebox - Bindings +source: external --- + {% include base.html %} # Squeezebox Binding +This binding integrates the [Logitech Media Server](http://www.mysqueezebox.com) and compatible Squeeze players. From the [Wikipedia entry](http://en.wikipedia.org/wiki/Squeezebox_%28network_music_player%29): @@ -13,7 +17,7 @@ From the [Wikipedia entry](http://en.wikipedia.org/wiki/Squeezebox_%28network_mu > In 2006, Slim Devices was acquired by Logitech for $20 million USD. Logitech continued the development of the player until they announced in August 2012 that it would be discontinued. Given the cross-platform nature of the server and software client, some users have ensured the continued use of the platform by utilizing the Raspberry Pi as dedicated Squeezebox device (both client and server). -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/squeezebox/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/squeezebox/readme.html). ## Table of Contents diff --git a/addons/bindings/oh1/stiebelheatpump/readme.md b/addons/bindings/oh1/stiebelheatpump/readme.md index 2271a762d..60bce1cfb 100644 --- a/addons/bindings/oh1/stiebelheatpump/readme.md +++ b/addons/bindings/oh1/stiebelheatpump/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Stiebel Eltron LWZ - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/swegonventilation/readme.md b/addons/bindings/oh1/swegonventilation/readme.md index 63221275f..1258f1c13 100644 --- a/addons/bindings/oh1/swegonventilation/readme.md +++ b/addons/bindings/oh1/swegonventilation/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Swegon Ventilation - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/systeminfo/readme.md b/addons/bindings/oh1/systeminfo/readme.md index 8d2988b28..dd0328fcc 100644 --- a/addons/bindings/oh1/systeminfo/readme.md +++ b/addons/bindings/oh1/systeminfo/readme.md @@ -1,21 +1,19 @@ --- layout: documentation +title: System Information - Bindings +source: external --- + {% include base.html %} ## System Information Binding -The System Information binding provides operating system monitoring data, including: - -- System memory, swap, CPU, load average, uptime -- Per-process memory, CPU -- File system metrics -- Network interface metrics +The System Information binding provides operating system monitoring data, including system memory, swap, CPU, load average, uptime, per-process memory, per-process CPU, file system metrics and network interface metrics. The binding uses the Hyperic SIGAR API to access system information regardless of the underlying platform (Windows, Linux, OS X...). -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/systeminfo/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/systeminfo/readme.html). ## Table of Contents diff --git a/addons/bindings/oh1/tacmi/readme.md b/addons/bindings/oh1/tacmi/readme.md index dbea83d08..caa376775 100644 --- a/addons/bindings/oh1/tacmi/readme.md +++ b/addons/bindings/oh1/tacmi/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: TACmi - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/tcp/readme.md b/addons/bindings/oh1/tcp/readme.md index 4010dbaef..7dc34cf1d 100644 --- a/addons/bindings/oh1/tcp/readme.md +++ b/addons/bindings/oh1/tcp/readme.md @@ -1,10 +1,13 @@ --- layout: documentation +title: TCP & UDP - Bindings +source: external --- + {% include base.html %} -# TCP & UDP Bindings +# TCP & UDP Binding The TCP and UDP bindings provide basic support for simple ASCII-based protocols. They send and receive data as ASCII strings. Data sent out is by default padded with a CR/LF. This should be sufficient for many home automation devices that take simple ASCII-based control commands, or that send back text-based status messages. diff --git a/addons/bindings/oh1/tellstick/readme.md b/addons/bindings/oh1/tellstick/readme.md index 4e87c629a..86a26ea2c 100644 --- a/addons/bindings/oh1/tellstick/readme.md +++ b/addons/bindings/oh1/tellstick/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Tellstick - Bindings +source: external --- + {% include base.html %} @@ -12,7 +15,7 @@ See further information from http://www.telldus.com The binding supports sensors (temperature and humidity) and devices (switches, dimmers and dimmers without an absolute level). -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/tellstick/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/tellstick/readme.html). ## Prerequisites diff --git a/addons/bindings/oh1/tinkerforge/readme.md b/addons/bindings/oh1/tinkerforge/readme.md index e8aef5d6b..6f66bd4e8 100644 --- a/addons/bindings/oh1/tinkerforge/readme.md +++ b/addons/bindings/oh1/tinkerforge/readme.md @@ -1,13 +1,32 @@ --- layout: documentation +title: TinkerForge - Bindings +source: external --- + {% include base.html %} # TinkerForge Binding +[TinkerForge](http://www.tinkerforge.com) is a system of open source hardware building blocks that allows you to combine sensor and actuator blocks by plug and play. You can create your individual hardware system by choosing the necessary building blocks for your project and combine it with other home automation products. + +There are many blocks available e.g for temperature, humidity or air pressure +measurement as well as for I/O, LCDs and motor control. You will find a complete List of available +blocks [here](http://www.tinkerforge.com/en/doc/Product_Overview.html). + +This binding connects the [TinkerForge](http://tinkerforge.com) devices to the openHAB event bus. +Sensor values from devices are made available to openHAB and actions on devices can be triggered by +openHAB. + +The binding supports the connection to several brickd instances. +The TinkerForge auto reconnect feature is supported. Furthermore even if the initial connect failed the binding will make retries to get connected to the brickd. + +--- +[Table of Contents](#table-of-contents) + ## Table of Contents -- [Introduction](#introduction) + - [Generic Item Binding Configuration](#generic-item-binding-configuration) - [Basic Configuration](#basic-configuration) - [Item Binding Configuration](#item-binding-configuration) @@ -75,27 +94,10 @@ layout: documentation --- -## Introduction -[TinkerForge](http://www.tinkerforge.com) is a system of open source hardware building blocks that -allows you to combine sensor and actuator blocks by plug and play. You can create your individual -hardware system by choosing the necessary building blocks for your project and combine it with other -home automation products. There are many blocks available e.g for temperature, humidity or air pressure -measurement as well as for I/O, LCDs and motor control. You will find a complete List of available -blocks [here](http://www.tinkerforge.com/en/doc/Product_Overview.html). - -This binding connects the [TinkerForge](http://tinkerforge.com) devices to the openHAB event bus. -Sensor values from devices are made available to openHAB and actions on devices can be triggered by -openHAB. - -The binding supports the connection to several brickd instances. -The TinkerForge auto reconnect feature is supported. Furthermore even if the initial connect failed the binding will make retries to get connected to the brickd. - ---- -[Table of Contents](#table-of-contents) - ## Generic Item Binding Configuration ### Basic Configuration + In order to connect openHAB to TinkerForge devices you need to define all the brickd hosts and ports in the services/tinkerforge.cfg file. The following properties must be configured to define a brickd connection: ``` diff --git a/addons/bindings/oh1/tivo/readme.md b/addons/bindings/oh1/tivo/readme.md index 9f997e39b..293288365 100644 --- a/addons/bindings/oh1/tivo/readme.md +++ b/addons/bindings/oh1/tivo/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: TiVo - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/ucprelayboard/readme.md b/addons/bindings/oh1/ucprelayboard/readme.md index 3d427465a..7fc4e064d 100644 --- a/addons/bindings/oh1/ucprelayboard/readme.md +++ b/addons/bindings/oh1/ucprelayboard/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: UCProjects.eu Relay Board - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/upb/readme.md b/addons/bindings/oh1/upb/readme.md index eb0719194..93c7d850b 100644 --- a/addons/bindings/oh1/upb/readme.md +++ b/addons/bindings/oh1/upb/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: UPB - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/urtsi/readme.md b/addons/bindings/oh1/urtsi/readme.md index c594ca673..b55f39a9c 100644 --- a/addons/bindings/oh1/urtsi/readme.md +++ b/addons/bindings/oh1/urtsi/readme.md @@ -1,14 +1,17 @@ --- layout: documentation +title: Somfy URTSI II - Bindings +source: external --- + {% include base.html %} -# Somfy URTSI II Binding (1.x) +# Somfy URTSI II Binding This binding communicates with Somfy URTSI II devices over a serial connection. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/urtsi/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/urtsi/readme.html). ## Binding Configuration diff --git a/addons/bindings/oh1/vdr/readme.md b/addons/bindings/oh1/vdr/readme.md index 6c072bad3..ac163ceb3 100644 --- a/addons/bindings/oh1/vdr/readme.md +++ b/addons/bindings/oh1/vdr/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Video Disk Recorder (VDR) - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/wago/readme.md b/addons/bindings/oh1/wago/readme.md index 00b0c45a7..ed7191c13 100644 --- a/addons/bindings/oh1/wago/readme.md +++ b/addons/bindings/oh1/wago/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: WAGO - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/weather/readme.md b/addons/bindings/oh1/weather/readme.md index 5b7d7260d..ea8f1be3e 100644 --- a/addons/bindings/oh1/weather/readme.md +++ b/addons/bindings/oh1/weather/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Weather - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/wemo/readme.md b/addons/bindings/oh1/wemo/readme.md index 034aaf360..a43598faf 100644 --- a/addons/bindings/oh1/wemo/readme.md +++ b/addons/bindings/oh1/wemo/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Wemo - Bindings +source: external --- + {% include base.html %} @@ -8,7 +11,7 @@ layout: documentation This binding integrates the [Belkin WeMo Family](http://www.belkin.com/us/Products/c/home-automation/). The integration happens either through the WeMo-Link bridge (feature still to come) which acts as an IP gateway to the ZigBee devices, or through Wi-Fi connection to standalone devices. -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/wemo/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/wemo/readme.html). ## Binding Configuration diff --git a/addons/bindings/oh1/withings/readme.md b/addons/bindings/oh1/withings/readme.md index 19eac4d9e..5b3d7cdf0 100644 --- a/addons/bindings/oh1/withings/readme.md +++ b/addons/bindings/oh1/withings/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Withings - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/wol/readme.md b/addons/bindings/oh1/wol/readme.md index b105edd2d..c2335d91c 100644 --- a/addons/bindings/oh1/wol/readme.md +++ b/addons/bindings/oh1/wol/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Wake-on-LAN - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/xbmc/readme.md b/addons/bindings/oh1/xbmc/readme.md index 995dafa21..edfdbb10a 100644 --- a/addons/bindings/oh1/xbmc/readme.md +++ b/addons/bindings/oh1/xbmc/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: XBMC binding (for KODI) (1.x) - Bindings +source: external --- + {% include base.html %} @@ -10,7 +13,7 @@ This binding allows openHAB items to receive realtime updates about information [![openhab binding for xbmc](http://img.youtube.com/vi/N7_5phTVbo0/0.jpg)](http://www.youtube.com/watch?v=N7_5phTVbo0) -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/kodi/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/kodi/readme.html). diff --git a/addons/bindings/oh1/xpl/readme.md b/addons/bindings/oh1/xpl/readme.md index 8fb2d6d3f..7b84e72b9 100644 --- a/addons/bindings/oh1/xpl/readme.md +++ b/addons/bindings/oh1/xpl/readme.md @@ -1,15 +1,15 @@ --- layout: documentation +title: xPL - Bindings +source: external --- + {% include base.html %} # xPL Binding -The xPL Bundle provides two packages : - -- Action to send messages over the xPL network -- Bindings to grab xPL message values in items and send xPL commands +The xPL binding grabs xPL message values in items and sends xPL commands. ## Prerequisites diff --git a/addons/bindings/oh1/yamahareceiver/readme.md b/addons/bindings/oh1/yamahareceiver/readme.md index d01229b9b..008dc1f1a 100644 --- a/addons/bindings/oh1/yamahareceiver/readme.md +++ b/addons/bindings/oh1/yamahareceiver/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Yamaha Receiver (1.x) - Bindings +source: external --- + {% include base.html %} @@ -39,7 +42,7 @@ Tested Receivers: Please add your own successfully tested receiver to this list! -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/yamahareceiver/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/yamahareceiver/readme.html). ## Binding Configuration diff --git a/addons/bindings/oh1/zibase/readme.md b/addons/bindings/oh1/zibase/readme.md index fa10fb826..fee282579 100644 --- a/addons/bindings/oh1/zibase/readme.md +++ b/addons/bindings/oh1/zibase/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Zibase - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh1/zwave/readme.md b/addons/bindings/oh1/zwave/readme.md index a784f0136..45f34f7a3 100644 --- a/addons/bindings/oh1/zwave/readme.md +++ b/addons/bindings/oh1/zwave/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Z-Wave - Bindings +source: external --- + {% include base.html %} @@ -21,7 +24,7 @@ The openHAB Z-Wave binding allows you to connect to your Z-Wave wireless mesh ne -There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/zwave/readme.html). +There is also a binding specifically for openHAB 2 [here](http://docs.openhab.org/addons/bindings/oh2/zwave/readme.html). ## Prerequisites diff --git a/addons/bindings/oh2/allplay/readme.md b/addons/bindings/oh2/allplay/readme.md index 2927f4d76..25330df2d 100644 --- a/addons/bindings/oh2/allplay/readme.md +++ b/addons/bindings/oh2/allplay/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: AllPlay - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/amazondashbutton/readme.md b/addons/bindings/oh2/amazondashbutton/readme.md index b680d69a6..1c4757b47 100644 --- a/addons/bindings/oh2/amazondashbutton/readme.md +++ b/addons/bindings/oh2/amazondashbutton/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Amazon Dash Button - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/astro/readme.md b/addons/bindings/oh2/astro/readme.md index 934f95e38..32545f166 100644 --- a/addons/bindings/oh2/astro/readme.md +++ b/addons/bindings/oh2/astro/readme.md @@ -1,12 +1,17 @@ --- layout: documentation +title: Astro - Bindings +source: external --- + {% include base.html %} # Astro Binding -The Astro binding is used for calculating many DateTime and positional values for sun and moon. +The Astro binding is used for calculating + * many DateTime and positional values for sun and moon. + * Radiation levels (direct, diffuse and total) of the sun during the day ## Supported Things @@ -24,6 +29,7 @@ No binding configuration required. A thing requires the geolocation (latitude, longitude) for which the calculation is done. Optionally, a refresh interval (in seconds) can be defined to also calculate positional data like azimuth and elevation. +An complementary altitude (optional) configuration item can also be specified to sharpen results provided by Radiation group. ## Channels @@ -35,6 +41,9 @@ Optionally, a refresh interval (in seconds) can be defined to also calculate pos * **group** `position` * **channel** * `azimuth, elevation` (Number) + * **group** `radiation` + * **channel** + * `direct, diffuse, total` (Number) * **group** `zodiac` * **channel** * `start, end` (DateTime) @@ -110,14 +119,14 @@ The minimum allowed offset is -1440 and the maximum allowed offset is 1440. Things: ``` -astro:sun:home [ geolocation="xx.xxxxxx,xx.xxxxxx", interval=60 ] +astro:sun:home [ geolocation="xx.xxxxxx,xx.xxxxxx", altitude=100, interval=60 ] astro:moon:home [ geolocation="xx.xxxxxx,xx.xxxxxx", interval=60 ] ``` or optionally with an offset ``` -astro:sun:home [ geolocation="xx.xxxxxx,xx.xxxxxx", interval=60 ] { +astro:sun:home [ geolocation="xx.xxxxxx,xx.xxxxxx", altitude=100, interval=60 ] { Channels: Type rangeEvent : rise#event [ offset=-30 @@ -129,11 +138,13 @@ astro:moon:home [ geolocation="xx.xxxxxx,xx.xxxxxx", interval=60 ] Items: ``` -DateTime Sunrise_Time "Sunrise [%1$tH:%1$tM]" { channel="astro:sun:home:rise#start" } -DateTime Sunset_Time "Sunset [%1$tH:%1$tM]" { channel="astro:sun:home:set#start" } -Number Azimuth "Azimuth [%.1f °]" { channel="astro:sun:home:position#azimuth" } -Number Elevation "Elevation [%.1f °]" { channel="astro:sun:home:position#elevation" } -String MoonPhase "Moon Phase [%s]" { channel="astro:moon:home:phase#name" } +DateTime Sunrise_Time "Sunrise [%1$tH:%1$tM]" { channel="astro:sun:home:rise#start" } +DateTime Sunset_Time "Sunset [%1$tH:%1$tM]" { channel="astro:sun:home:set#start" } +Number Azimuth "Azimuth" { channel="astro:sun:home:position#azimuth" } +Number Elevation "Elevation" { channel="astro:sun:home:position#elevation" } +String MoonPhase "MoonPhase" { channel="astro:moon:home:phase#name" } +Number Total_Radiation "Radiation" { channel="astro:sun:home:radiation#total" } +Number Total_Radiation "Radiation" { channel="astro:sun:home:radiation#total" } ``` Events: diff --git a/addons/bindings/oh2/autelis/readme.md b/addons/bindings/oh2/autelis/readme.md index dc486eab6..c8f5b7046 100644 --- a/addons/bindings/oh2/autelis/readme.md +++ b/addons/bindings/oh2/autelis/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Autelis Pool Control - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/avmfritz/readme.md b/addons/bindings/oh2/avmfritz/readme.md index 789bf1b29..845ed80b0 100644 --- a/addons/bindings/oh2/avmfritz/readme.md +++ b/addons/bindings/oh2/avmfritz/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: AVM FRITZ! - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/boschindego/readme.md b/addons/bindings/oh2/boschindego/readme.md new file mode 100644 index 000000000..958101ffa --- /dev/null +++ b/addons/bindings/oh2/boschindego/readme.md @@ -0,0 +1,85 @@ +--- +layout: documentation +title: Bosch Indego - Bindings +source: external +--- + + +{% include base.html %} + +# Bosch Indego Binding + +This is the Binding for Bosch Indego Connect lawn mowers. + +Thank´s to zazaz-de who found out how the API works. His [Java Library](https://github.com/zazaz-de/iot-device-bosch-indego-controller) made this Binding possible. + +## Configuration of the thing + + +Currently the binding supports ***indego*** mowers as a thing type with this parameters: + +| parameter | datatype | required | +|---|---|---| +| username | String | yes | +| password | String | yes | +| refresh | integer| no (default: 180, minimum: 60)| + +The refresh interval is specified in seconds. + +A possible entry in your thing file could be: + +``` +boschindego:indego:lawnmower [username="myname@myhost.tld", password="idontneedtocutthelawnagain", refresh=120] +``` + + +## Channels + + channel | item-type | description | +|---|---|---| +| state | Number | You can send commands to this channel to control the mower and read the simplified state from it (1=mow, 2=return to dock, 3=pause)| +| errorcode | Number | Errorcode of the mower (0=no error, readonly) | +| statecode | Number | Detailed state of the mower. I included English and German map-files to read the state easier (readonly)| +|textualstate| String| State as a text. (readonly)| +|ready | Number | Shows if the mower is ready to mow (1=ready, 0=not ready, readonly)| +|mowed | Dimmer | Cut grass in percent (readonly)| + +For example you can use this sitemap entry to control the mower manually: + +``` +Switch item=indegostate mappings=[ 1="Mow", 2="Return",3="Pause" ] +``` + +## Meaning of the numeric statecodes + +You can use this as .map file + +``` +0=Reading status +257=Charging +258=Docked +259=Docked - Software update +260=Docked +261=Docked +262=Docked - Loading map +263=Docked - Saving map +513=Mowing +514=Relocalising +515=Loading map +516=Learning lawn +517=Paused +518=Border cut +519=Idle in lawn +769=Returning to Dock +770=Returning to Dock +771=Returning to Dock - Battery low +772=Returning to dock - Calendar timeslot ended +773=Returning to dock - Battery temp range +774=Returning to dock +775=Returning to dock - Lawn complete +776=Returning to dock - Relocalising +``` + + + + diff --git a/addons/bindings/oh2/chromecast/readme.md b/addons/bindings/oh2/chromecast/readme.md index 3da561370..4b5881d8e 100644 --- a/addons/bindings/oh2/chromecast/readme.md +++ b/addons/bindings/oh2/chromecast/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Chromecast - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/coolmasternet/readme.md b/addons/bindings/oh2/coolmasternet/readme.md index fee0ca7ce..296613633 100644 --- a/addons/bindings/oh2/coolmasternet/readme.md +++ b/addons/bindings/oh2/coolmasternet/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: CoolMasterNet - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/dscalarm/readme.md b/addons/bindings/oh2/dscalarm/readme.md index 176e48615..cdd13c069 100644 --- a/addons/bindings/oh2/dscalarm/readme.md +++ b/addons/bindings/oh2/dscalarm/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: DSC Alarm - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/exec/readme.md b/addons/bindings/oh2/exec/readme.md index 53f6da238..f6919e08e 100644 --- a/addons/bindings/oh2/exec/readme.md +++ b/addons/bindings/oh2/exec/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Exec - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/feed/readme.md b/addons/bindings/oh2/feed/readme.md index d30f43aaa..96e55fda6 100644 --- a/addons/bindings/oh2/feed/readme.md +++ b/addons/bindings/oh2/feed/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Feed - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/freebox/readme.md b/addons/bindings/oh2/freebox/readme.md index 45dbd8355..a7fadc4b6 100644 --- a/addons/bindings/oh2/freebox/readme.md +++ b/addons/bindings/oh2/freebox/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Freebox - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/globalcache/readme.md b/addons/bindings/oh2/globalcache/readme.md index 2a1fbb8fa..4c733b634 100644 --- a/addons/bindings/oh2/globalcache/readme.md +++ b/addons/bindings/oh2/globalcache/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: GlobalCache - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/harmonyhub/readme.md b/addons/bindings/oh2/harmonyhub/readme.md index 32282e888..7c7095850 100644 --- a/addons/bindings/oh2/harmonyhub/readme.md +++ b/addons/bindings/oh2/harmonyhub/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Logitech Harmony Hub - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/hdpowerview/readme.md b/addons/bindings/oh2/hdpowerview/readme.md index 10face96f..e5545ea1e 100644 --- a/addons/bindings/oh2/hdpowerview/readme.md +++ b/addons/bindings/oh2/hdpowerview/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Hunter Douglas PowerView - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/homematic/readme.md b/addons/bindings/oh2/homematic/readme.md index d21d68d0f..2159e8968 100644 --- a/addons/bindings/oh2/homematic/readme.md +++ b/addons/bindings/oh2/homematic/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Homematic - Bindings +source: external --- + {% include base.html %} @@ -26,6 +29,7 @@ These ports are used by the binding by default to communicate **TO** the gateway - HMIP components: 2010 - CUxD: 8701 - TclRegaScript: 8181 +- Groups: 9292 And **FROM** the gateway to openHab: - XML-RPC: 9125 @@ -38,6 +42,7 @@ And **FROM** the gateway to openHab: * **WIRED**: BIN-RPC * **HMIP**: XML-RPC * **CUxD**: BIN-RPC (CUxD version >= 1.6 required) + * **Groups**: XML-RPC * **Homegear** * BIN-RPC * **Other** @@ -190,6 +195,12 @@ Address: fixed GWE00000000 #### RELOAD_ALL_FROM_GATEWAY A virtual datapoint (Switch) to reload all values for all devices, available in channel 0 in GATEWAY-EXTRAS +#### RELOAD_RSSI +A virtual datapoint (Switch) to reload all rssi values for all devices, available in channel 0 in GATEWAY-EXTRAS + +#### RSSI +A virtual datapoint (Number) with the unified RSSI value from RSSI_DEVICE and RSSI_PEER, available in channel 0 for all wireless devices + #### INSTALL_MODE A virtual datapoint (Switch) to start the install mode on the gateway, available in channel 0 in GATEWAY-EXTRAS diff --git a/addons/bindings/oh2/ipp/readme.md b/addons/bindings/oh2/ipp/readme.md index 71f268785..201608175 100644 --- a/addons/bindings/oh2/ipp/readme.md +++ b/addons/bindings/oh2/ipp/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: IPP - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/keba/readme.md b/addons/bindings/oh2/keba/readme.md index d732e1a1d..edb78d0e0 100644 --- a/addons/bindings/oh2/keba/readme.md +++ b/addons/bindings/oh2/keba/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Keba - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/kodi/readme.md b/addons/bindings/oh2/kodi/readme.md index 7b0933e2f..6d617740f 100644 --- a/addons/bindings/oh2/kodi/readme.md +++ b/addons/bindings/oh2/kodi/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Kodi - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/lutron/readme.md b/addons/bindings/oh2/lutron/readme.md index 95a4b370c..ec60c97d3 100644 --- a/addons/bindings/oh2/lutron/readme.md +++ b/addons/bindings/oh2/lutron/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Lutron - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/max/readme.md b/addons/bindings/oh2/max/readme.md index 372d7e1c4..508a898d5 100644 --- a/addons/bindings/oh2/max/readme.md +++ b/addons/bindings/oh2/max/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: MAX! - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/meteostick/readme.md b/addons/bindings/oh2/meteostick/readme.md index 08fa8a75d..f75e58461 100644 --- a/addons/bindings/oh2/meteostick/readme.md +++ b/addons/bindings/oh2/meteostick/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Meteostick - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/milight/readme.md b/addons/bindings/oh2/milight/readme.md index 8f479924b..17d39d8d8 100644 --- a/addons/bindings/oh2/milight/readme.md +++ b/addons/bindings/oh2/milight/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Milight - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/minecraft/readme.md b/addons/bindings/oh2/minecraft/readme.md index d9b58d90f..2a4857c5d 100644 --- a/addons/bindings/oh2/minecraft/readme.md +++ b/addons/bindings/oh2/minecraft/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Minecraft - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/network/readme.md b/addons/bindings/oh2/network/readme.md index 371b5679f..fd5cf8295 100644 --- a/addons/bindings/oh2/network/readme.md +++ b/addons/bindings/oh2/network/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Network - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/oceanic/readme.md b/addons/bindings/oh2/oceanic/readme.md index 1d8b8787f..9c5ee9c29 100644 --- a/addons/bindings/oh2/oceanic/readme.md +++ b/addons/bindings/oh2/oceanic/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Oceanic - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/onkyo/readme.md b/addons/bindings/oh2/onkyo/readme.md index 9ed55d136..b437efb58 100644 --- a/addons/bindings/oh2/onkyo/readme.md +++ b/addons/bindings/oh2/onkyo/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Onkyo - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/opensprinkler/readme.md b/addons/bindings/oh2/opensprinkler/readme.md index a24bac084..f262b8321 100644 --- a/addons/bindings/oh2/opensprinkler/readme.md +++ b/addons/bindings/oh2/opensprinkler/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: OpenSprinkler - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/orvibo/readme.md b/addons/bindings/oh2/orvibo/readme.md index 9138897c3..f12fee2ff 100644 --- a/addons/bindings/oh2/orvibo/readme.md +++ b/addons/bindings/oh2/orvibo/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Orvibo - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/pioneeravr/readme.md b/addons/bindings/oh2/pioneeravr/readme.md index 539d966fc..43fc21bf8 100644 --- a/addons/bindings/oh2/pioneeravr/readme.md +++ b/addons/bindings/oh2/pioneeravr/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: PioneerAVR Configuration - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/pulseaudio/readme.md b/addons/bindings/oh2/pulseaudio/readme.md index 21e320e10..990138232 100644 --- a/addons/bindings/oh2/pulseaudio/readme.md +++ b/addons/bindings/oh2/pulseaudio/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Pulseaudio - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/rfxcom/readme.md b/addons/bindings/oh2/rfxcom/readme.md index c48bc76cc..b3f5ce190 100644 --- a/addons/bindings/oh2/rfxcom/readme.md +++ b/addons/bindings/oh2/rfxcom/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: RFXCOM - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/rme/readme.md b/addons/bindings/oh2/rme/readme.md index be001e53e..510983ca2 100644 --- a/addons/bindings/oh2/rme/readme.md +++ b/addons/bindings/oh2/rme/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: RME - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/russound/readme.md b/addons/bindings/oh2/russound/readme.md index d03e17f99..74275711a 100644 --- a/addons/bindings/oh2/russound/readme.md +++ b/addons/bindings/oh2/russound/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Russound - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/samsungtv/readme.md b/addons/bindings/oh2/samsungtv/readme.md index 0e0b31ade..4b1f38b8a 100644 --- a/addons/bindings/oh2/samsungtv/readme.md +++ b/addons/bindings/oh2/samsungtv/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Samsung TV - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/silvercrestwifisocket/readme.md b/addons/bindings/oh2/silvercrestwifisocket/readme.md index 6f2d05cbd..1620a7c1e 100644 --- a/addons/bindings/oh2/silvercrestwifisocket/readme.md +++ b/addons/bindings/oh2/silvercrestwifisocket/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Silvercrest Wifi Plug - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/smaenergymeter/readme.md b/addons/bindings/oh2/smaenergymeter/readme.md index b62b279bb..7e314debb 100644 --- a/addons/bindings/oh2/smaenergymeter/readme.md +++ b/addons/bindings/oh2/smaenergymeter/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: SMA Energy Meter - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/squeezebox/readme.md b/addons/bindings/oh2/squeezebox/readme.md index 9e2e8c0c9..c902ec220 100644 --- a/addons/bindings/oh2/squeezebox/readme.md +++ b/addons/bindings/oh2/squeezebox/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Logitech Squeezebox - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/systeminfo/readme.md b/addons/bindings/oh2/systeminfo/readme.md index 7ce28d0ba..a210ac6cd 100644 --- a/addons/bindings/oh2/systeminfo/readme.md +++ b/addons/bindings/oh2/systeminfo/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Systeminfo - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/tellstick/readme.md b/addons/bindings/oh2/tellstick/readme.md index 9bb0069ac..fb42ff993 100644 --- a/addons/bindings/oh2/tellstick/readme.md +++ b/addons/bindings/oh2/tellstick/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Tellstick - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/tesla/readme.md b/addons/bindings/oh2/tesla/readme.md index 28e64a1b0..df2e05546 100644 --- a/addons/bindings/oh2/tesla/readme.md +++ b/addons/bindings/oh2/tesla/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Tesla - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/urtsi/readme.md b/addons/bindings/oh2/urtsi/readme.md index b7505a569..658664919 100644 --- a/addons/bindings/oh2/urtsi/readme.md +++ b/addons/bindings/oh2/urtsi/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Somfy URTSI II - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/vitotronic/readme.md b/addons/bindings/oh2/vitotronic/readme.md index 3d3fb2da0..8339ab43f 100644 --- a/addons/bindings/oh2/vitotronic/readme.md +++ b/addons/bindings/oh2/vitotronic/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Vitotronic - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/wifiled/readme.md b/addons/bindings/oh2/wifiled/readme.md new file mode 100644 index 000000000..6a9d497ce --- /dev/null +++ b/addons/bindings/oh2/wifiled/readme.md @@ -0,0 +1,99 @@ +--- +layout: documentation +title: WiFi LED - Bindings +source: external +--- + + +{% include base.html %} + +# WiFi LED Binding + +This binding is used to control LED stripes connected by WiFi. These devices are sold with different names, i.e. Magic Home LED, UFO LED, LED NET controller, etc. + +## Supported Things + +The following table shows a list of RGBW(W) LED devices supported by this binding. + +Device table with supported channels: + +| Device Type | power | color | white | white2 | program | programSpeed | +|-------------|:-----:|:-----:|:-----:|:------:|:-------:|:------------:| +| LD382 | ✓ | ✓ | ✓ | | ✓ | ✓ | +| LD382A | ✓ | ✓ | ✓ | | ✓ | ✓ | +| LD686 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | + +Other LD*** devices might work but probably need some small adaptions. + +## Discovery + +The LED WiFi Controllers can be discovered by triggering a search in openHAB's inbox. +Your device needs to be connected to your local network +(i.e. by using the WiFi PBC connection method or the native App shipped with the device). +Read the device manual for more information about how to connect your device to your network. + +## Binding Configuration + +No binding configuration required. + +## Thing Configuration + +The thing can be configured through the Paper UI. +Use the configuration if you have devices of type LD382 or LD686, want to enable color fading, +or if the device discovery does not find your LED controller automatically. + +### Drivers + +You can choose between two drivers with different functionality: + +| Driver | Supports Color Fading | Supports Programs | Polls LED State | +|---------|:---------------------:|:-----------------:|:---------------:| +| CLASSIC | | ✓ | ✓ | +| FADING | ✓ | | | + +While the CLASSIC driver let you choose and run device internal programs (e.g. alternating blue), +all normal operations (turn on or off, switch color, set brightness, ...) are performed immediately +and without any fading effect. + +If you prefer to switch colors smoothly and to turn your light on and off by slightly rising/decreasing the brightness +you should try the FADING driver. +If selected you can also set the number of fading steps and the fading duration in the thing configuration. +Note that each fading step will at least take 10 ms for being processed. +This natural limit is given by the speed of the LED controller and your network speed. +Thus, a color fading with a configured fading duration of 0s might still take some time +(count with more than 1 second for 100 steps). +IF the "FADING" driver is chosen the program channel and the programSpeed channel will not have any effect. + +The polling period is a parameter only used by the CLASSIC driver and specifies a the time in seconds +after the LED state is refreshed in openHAB. + +### Device Discovery + +If the automatic discovery fails you have to set the IP address and the port of your device manually. +Moreover, make sure that the device protocol matches you device type. + +## Channels + +| Channel Type ID | Item Type | Description | Access | +|-----------------|-----------|------------------------------------------------------|--------| +| power | Switch | Power state of the LEDs (ON/OFF) | R/W | +| color | Color | Color of the RGB LEDs | R/W | +| white | Dimmer | Brightness of the first (warm) white LEDs (min=0, max=100) | R/W | +| white2 | Dimmer | Brightness of the second (warm) white LEDs (min=0, max=100) | R/W | +| program | String | Program to run by the controller (i.e. color cross fade, strobe, etc.) | R/W | +| programSpeed | Dimmer | Speed of the program | R/W | + +## Full example + +Usually, there is no need to define your WiFi LED controllers via configuration files. +However, if you like to do it, here is an example. + +wifiled.things: + + Thing wifiled:wifiled:F0FE6B19CB2A [ ip="192.168.178.91", port=5577, pollingPeriod=3000, protocol="LD686", driver="CLASSIC", fadeDurationInMs=1000, fadeSteps=100 ] + +wifiled.items: + + Switch MyWiFiLight_power "Power" (Light) {channel="wifiled:wifiled:F0FE6B19CB2A:power"} + Dimmer MyWiFiLight_white "White" (Light) {channel="wifiled:wifiled:F0FE6B19CB2A:white"} + Color MyWiFiLight_color "Color" (Light) {channel="wifiled:wifiled:F0FE6B19CB2A:color"} diff --git a/addons/bindings/oh2/yamahareceiver/readme.md b/addons/bindings/oh2/yamahareceiver/readme.md index d40e8c0e3..eca081ffb 100644 --- a/addons/bindings/oh2/yamahareceiver/readme.md +++ b/addons/bindings/oh2/yamahareceiver/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Yamahareceiver - Bindings +source: external --- + {% include base.html %} diff --git a/addons/bindings/oh2/zway/readme.md b/addons/bindings/oh2/zway/readme.md index 558ba4ee1..dad78f918 100644 --- a/addons/bindings/oh2/zway/readme.md +++ b/addons/bindings/oh2/zway/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Z-Way - Bindings +source: external --- + {% include base.html %} diff --git a/addons/io/homekit/readme.md b/addons/io/oh2/org.openhab.io.homekit/README.md similarity index 99% rename from addons/io/homekit/readme.md rename to addons/io/oh2/org.openhab.io.homekit/README.md index 05caf545c..0b233cfb1 100644 --- a/addons/io/homekit/readme.md +++ b/addons/io/oh2/org.openhab.io.homekit/README.md @@ -1,9 +1,3 @@ ---- -layout: documentation ---- - -{% include base.html %} - # HomeKit Add-on This is an add-on that exposes your openHAB system as a bridge over the HomeKit protocol. diff --git a/addons/io/hueemulation/readme.md b/addons/io/oh2/org.openhab.io.hueemulation/README.md similarity index 95% rename from addons/io/hueemulation/readme.md rename to addons/io/oh2/org.openhab.io.hueemulation/README.md index f96557470..c45a73185 100644 --- a/addons/io/hueemulation/readme.md +++ b/addons/io/oh2/org.openhab.io.hueemulation/README.md @@ -1,9 +1,3 @@ ---- -layout: documentation ---- - -{% include base.html %} - # openHAB Hue Emulation Service Hue Emulation exposes openHAB items as Hue devices to other Hue HTTP API compatible applications like an Amazon Echo. diff --git a/addons/io/imperihome/readme.md b/addons/io/oh2/org.openhab.io.imperihome/README.md similarity index 99% rename from addons/io/imperihome/readme.md rename to addons/io/oh2/org.openhab.io.imperihome/README.md index 09d573dd8..04e71c3df 100644 --- a/addons/io/imperihome/readme.md +++ b/addons/io/oh2/org.openhab.io.imperihome/README.md @@ -1,9 +1,3 @@ ---- -layout: documentation ---- - -{% include base.html %} - # ImperiHome integration service This IO service exposes openHAB Items to the Evertygo [ImperiHome](http://www.evertygo.com/imperihome) dashboard app for Android and iOS. diff --git a/addons/io/openhabcloud/readme.md b/addons/io/oh2/org.openhab.io.openhabcloud/README.md similarity index 98% rename from addons/io/openhabcloud/readme.md rename to addons/io/oh2/org.openhab.io.openhabcloud/README.md index 59b1ee453..ccafef8d1 100644 --- a/addons/io/openhabcloud/readme.md +++ b/addons/io/oh2/org.openhab.io.openhabcloud/README.md @@ -1,9 +1,3 @@ ---- -layout: documentation ---- - -{% include base.html %} - # openHAB Cloud Connector The openHAB Cloud Connector allows connecting the local openHAB runtime to a remote [openHAB Cloud](https://github.com/openhab/openhab-cloud/blob/master/README.md) instance, such as [myopenHAB.org](http://www.myopenHAB.org), which is an instance of the diff --git a/addons/io/openhabcloud/doc/cfg.png b/addons/io/oh2/org.openhab.io.openhabcloud/doc/cfg.png similarity index 100% rename from addons/io/openhabcloud/doc/cfg.png rename to addons/io/oh2/org.openhab.io.openhabcloud/doc/cfg.png diff --git a/addons/persistence/oh1/caldav/readme.md b/addons/persistence/oh1/caldav/readme.md index e53c0a317..e135cf370 100644 --- a/addons/persistence/oh1/caldav/readme.md +++ b/addons/persistence/oh1/caldav/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: CalDAV - Persistence +source: external --- + {% include base.html %} diff --git a/addons/persistence/oh1/cosm/readme.md b/addons/persistence/oh1/cosm/readme.md index 6c1ee978a..196f230c7 100644 --- a/addons/persistence/oh1/cosm/readme.md +++ b/addons/persistence/oh1/cosm/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Xively (formerly Cosm) - Persistence +source: external --- + {% include base.html %} diff --git a/addons/persistence/oh1/db4o/readme.md b/addons/persistence/oh1/db4o/readme.md index 983814ede..a8ef8d395 100644 --- a/addons/persistence/oh1/db4o/readme.md +++ b/addons/persistence/oh1/db4o/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: db4o - Persistence +source: external --- + {% include base.html %} diff --git a/addons/persistence/oh1/dynamodb.test/readme.md b/addons/persistence/oh1/dynamodb.test/readme.md deleted file mode 100644 index 56910a813..000000000 --- a/addons/persistence/oh1/dynamodb.test/readme.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: documentation ---- - -{% include base.html %} - -To run integration tests, one needs to provide AWS credentials. - -Eclipse instructions -1. Run all tests (in package org.openhab.persistence.dynamodb.internal) as JUnit Tests -2. Configure the run configuration, and open Arguments sheet -3. In VM arguments, provide the credentials for AWS -```` --DDYNAMODBTEST_REGION=REGION-ID --DDYNAMODBTEST_ACCESS=ACCESS-KEY --DDYNAMODBTEST_SECRET=SECRET -```` - -The tests will create tables with prefix `dynamodb-integration-tests-`. Note that when tests are begun, all data is removed from that table! \ No newline at end of file diff --git a/addons/persistence/oh1/dynamodb/readme.md b/addons/persistence/oh1/dynamodb/readme.md index 052141bb7..e5e0f3c65 100644 --- a/addons/persistence/oh1/dynamodb/readme.md +++ b/addons/persistence/oh1/dynamodb/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Amazon DynamoDB - Persistence +source: external --- + {% include base.html %} diff --git a/addons/persistence/oh1/exec/readme.md b/addons/persistence/oh1/exec/readme.md index fdb2472f5..05b49d295 100644 --- a/addons/persistence/oh1/exec/readme.md +++ b/addons/persistence/oh1/exec/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Exec - Persistence +source: external --- + {% include base.html %} diff --git a/addons/persistence/oh1/influxdb/readme.md b/addons/persistence/oh1/influxdb/readme.md index 117a3819d..631331844 100644 --- a/addons/persistence/oh1/influxdb/readme.md +++ b/addons/persistence/oh1/influxdb/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: InfluxDB (0.9 and newer) - Persistence +source: external --- + {% include base.html %} diff --git a/addons/persistence/oh1/influxdb08/readme.md b/addons/persistence/oh1/influxdb08/readme.md index cf5ebf8d5..5bb99b536 100644 --- a/addons/persistence/oh1/influxdb08/readme.md +++ b/addons/persistence/oh1/influxdb08/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: InfluxDB (up to 0.8.x) - Persistence +source: external --- + {% include base.html %} diff --git a/addons/persistence/oh1/jdbc/readme.md b/addons/persistence/oh1/jdbc/readme.md index 236ca725d..70dafa783 100644 --- a/addons/persistence/oh1/jdbc/readme.md +++ b/addons/persistence/oh1/jdbc/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: JDBC - Persistence +source: external --- + {% include base.html %} diff --git a/addons/persistence/oh1/jpa/readme.md b/addons/persistence/oh1/jpa/readme.md index 719b0c4ef..9eb9b4784 100644 --- a/addons/persistence/oh1/jpa/readme.md +++ b/addons/persistence/oh1/jpa/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Java Persistence API (JPA) - Persistence +source: external --- + {% include base.html %} diff --git a/addons/persistence/oh1/mapdb/readme.md b/addons/persistence/oh1/mapdb/readme.md index 65448e1ea..7e7a4551f 100644 --- a/addons/persistence/oh1/mapdb/readme.md +++ b/addons/persistence/oh1/mapdb/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: mapdb - Persistence +source: external --- + {% include base.html %} diff --git a/addons/persistence/oh1/mongodb/readme.md b/addons/persistence/oh1/mongodb/readme.md index b605d04eb..a5bc4b62d 100644 --- a/addons/persistence/oh1/mongodb/readme.md +++ b/addons/persistence/oh1/mongodb/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: MongoDB - Persistence +source: external --- + {% include base.html %} diff --git a/addons/persistence/oh1/mqtt/readme.md b/addons/persistence/oh1/mqtt/readme.md index c1309099b..90e00e98e 100644 --- a/addons/persistence/oh1/mqtt/readme.md +++ b/addons/persistence/oh1/mqtt/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: MQTT - Persistence +source: external --- + {% include base.html %} diff --git a/addons/persistence/oh1/mysql/readme.md b/addons/persistence/oh1/mysql/readme.md index 002aa064d..d03f8b2d1 100644 --- a/addons/persistence/oh1/mysql/readme.md +++ b/addons/persistence/oh1/mysql/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: MySQL - Persistence +source: external --- + {% include base.html %} diff --git a/addons/persistence/oh1/rrd4j/readme.md b/addons/persistence/oh1/rrd4j/readme.md index acc3840e9..ce14abdbe 100644 --- a/addons/persistence/oh1/rrd4j/readme.md +++ b/addons/persistence/oh1/rrd4j/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: rrd4j - Persistence +source: external --- + {% include base.html %} diff --git a/addons/persistence/oh1/sense/readme.md b/addons/persistence/oh1/sense/readme.md index 024f4e165..e6f0fe585 100644 --- a/addons/persistence/oh1/sense/readme.md +++ b/addons/persistence/oh1/sense/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: Sen.Se - Persistence +source: external --- + {% include base.html %} diff --git a/addons/persistence/oh1/sitewhere/readme.md b/addons/persistence/oh1/sitewhere/readme.md index 5c8ed0a8b..b454690f8 100644 --- a/addons/persistence/oh1/sitewhere/readme.md +++ b/addons/persistence/oh1/sitewhere/readme.md @@ -1,6 +1,9 @@ --- layout: documentation +title: SiteWhere - Persistence +source: external --- + {% include base.html %} diff --git a/bundles/io/oh1/org.openhab.io.caldav/README.md b/bundles/io/oh1/org.openhab.io.caldav/README.md new file mode 100644 index 000000000..c5cdbe661 --- /dev/null +++ b/bundles/io/oh1/org.openhab.io.caldav/README.md @@ -0,0 +1,7 @@ +# CalDAV IO Binding + +## Implementation Notes + +The specific versions inside the MANIFEST.MF are required +because of the used libraries for querying the calendar entries from the caldav server. +If they are not specified the osgi runtime will use newer versions which will not work. \ No newline at end of file diff --git a/bundles/io/oh1/org.openhab.io.dropbox/README.md b/bundles/io/oh1/org.openhab.io.dropbox/README.md new file mode 100644 index 000000000..18818e2a4 --- /dev/null +++ b/bundles/io/oh1/org.openhab.io.dropbox/README.md @@ -0,0 +1,64 @@ +# Dropbox Synchronization Service + +This service will synchronize files on your openHAB server, such as configuration and log files, to and/or from your Dropbox account. + +The intended main use cases are backing up openHAB configuration and log files to a version-able cloud space and transporting changed files back to openHAB after editing them with the openHAB Designer on the administrator's desktop PC. + +> NOTE: This service is currently disabled, due to [#4588](https://github.com/openhab/openhab1-addons/issues/4588). + +## Service Configuration + +This service can be configured in the file `services/dropbox.cfg`. + +| Property | Default | Required | Description | +|----------|---------|:--------:|-------------| +| appkey | `gbrwwfzvrw6a9uv` | Yes due to [#4588](https://github.com/openhab/openhab1-addons/issues/4588) | the default app key is defunct and code changes are necessary. | +| appsecret | `gu5v7lp1f5bbs07` | Yes due to [#4588](https://github.com/openhab/openhab1-addons/issues/4588) | the default app secret is defunct and code changes are necessary. | +| fakemode | `false` | No | operates the synchronizer in fake mode which avoids uploading files to or downloading files from Dropbox. Set to `true` as a test mode for the filter settings. | +| contentdir | openHAB configuration directory | No | the base directory to synchronize with openHAB, configure `uploadFilter` and `downloadFilter` to select files | +| uploadInterval | `0 0 2 * * ?` | No | a [cron expression](http://quartz-scheduler.org/documentation/quartz-2.1.x/tutorials/tutorial-lesson-06) to set the schedule for uploading changes to Dropbox. The default schedule uploads changes every day at 2am. | +| downloadInterval | `0 0/5 * * * ?` | No | a [cron expression](http://quartz-scheduler.org/documentation/quartz-2.1.x/tutorials/tutorial-lesson-06) to set the schedule for downloading changes from Dropbox. The default schedule downloads any changes every five minutes. | +| syncmode | `LOCAL_TO_DROPBOX` | No | There are three different synchronization modes available:

`DROPBOX_TO_LOCAL` - changed files will be downloaded from your Dropbox to openHAB only
`LOCAL_TO_DROPBOX` - locally changed files will be uploaded to your Dropbox only
`BIDIRECTIONAL` - files will be synchronized from Dropbox to your local openHAB and vice versa. All changes will be downloaded from Dropbox to your local system first. After that any local changes will be uploaded to Dropbox. Hence a concurrent change to one file will be overruled by Dropbox in any case.

In case your Dropbox returns the `reset` flag, all local files will be uploaded to your Dropbox once, even if your synchronization mode is set to `DROPBOX_TO_LOCAL`. The `reset` flag might be returned either if the synchronization has been the first call ever (so no delta cursor is available) or there might be technical issues at Dropbox which causes the connected clients to resynchronize their states with Dropbox again. | +| uploadfilter | `^([^/]*/){1}[^/]*$,/configurations.*,/logs/.*,/etc/.*` | No | The defaults are specific to openHAB 1.x running on Unix-like systems | +| downloadfilter | `^([^/]*/){1}[^/]*$,/configurations.*` | No | The defaults are specific to openHAB 1.x running on Unix-like systems | + +## Authorize openHAB + +You'll have to authorize openHAB to connect to your Dropbox. This is done in a three-step process. openHAB requests a token which is used as a one-time-password to obtain an access token (second step) which will be used for all future requests against Dropbox. + +### Step 1: Monitor Log for Authorization Message + +This service issues a message to the log automatically on first startup. You will find some log entries (also in the console) containing entries like these: + +```text + ######################################################################################### + # Dropbox-Integration: U S E R I N T E R A C T I O N R E Q U I R E D !! + # 1. Open URL 'https://www.dropbox.com/1/oauth2/_type=code' + # 2. Allow openHAB to access Dropbox + # 3. Paste the authorisation code here using the command 'dropbox:finishAuthentication ""' + ######################################################################################### +``` + +### Step 2: Obtain Authorization Token + +Copy the given URL to your browser and authorize openHAB to use Dropbox in the future. Be aware that the request token is only valid for the next five minutes, so don't be to placid. + +After successful authorization, a token is shown on the Dropbox web page: + +![](https://github.com/openhab/openhab1-addons/wiki/images/screenshots/dropbox-authorization.png) + +### Step 3: Save Token in openHAB Console + +Access the openHAB console to reach the `openhab>` prompt. One way you can access the openHAB 2 console from the server with: + +```shell +ssh openhab@localhost -p 8101 +``` + +The default password is `habopen`. If this is the first time accessing your console, it may take some time to generate cryptographic keys. + +Copy the token shown on the Dropbox Web page and issue the following command + +```text +dropbox:finishAuthentication "replace with the token" +``` diff --git a/bundles/io/oh1/org.openhab.io.gcal/README.md b/bundles/io/oh1/org.openhab.io.gcal/README.md new file mode 100644 index 000000000..e7d45ff87 --- /dev/null +++ b/bundles/io/oh1/org.openhab.io.gcal/README.md @@ -0,0 +1,157 @@ +# Google Calendar Scheduler + +The Google Calendar Scheduler allows you to control items in openHAB at scheduled times in the future. It will send commands to items or update the state of items when defined on one of your Google Calendars. + +An additional persistence service, the Google Calendar Presence Simulator, writes item state changes as events on the calendar that will occur again some number of days in the future, to simulate your activity at home (such as turning lights on and off) when on vacation. + +## Table of Contents + + + +- [Obtaining Credentials](#obtaining-credentials) +- [Service Configuration](#service-configuration) +- [Calendar Event Configuration](#calendar-event-configuration) +- [Presence Simulation](#presence-simulation) + - [Solving Google Calendar Presence Simulation errors](#solving-google-calendar-presence-simulation-errors) + + + +## Obtaining Credentials + +Before you can integrate this service with your Google Calendar, you must have a Google API Console project. + +* Login to your [Google API Manager](https://console.developers.google.com). +* From the project drop-down, select an existing project or create a new one by selecting **Create project**. +* In the sidebar under "API Manager", select Credentials, then select the OAuth consent screen tab. +* Choose an **Email Address**, specify a **Product Name**, and press Save. +* In the Credentials tab, select the Create credentials drop-down list, and choose **OAuth client ID**. +* Under **Application type**, select **Other**. +* Put **Name** and press the **Create** button. +* Copy **client id** and **client secret** + +## Service Configuration + +This service can be configured in the file `services/gcal.cfg`. + +| Property | Default | Required | Description | +|----------|---------|:--------:|-------------| +| client_id | | Yes | Copied from the "Client ID" field on the Credentials page as described above in [Obtaining Credentials](#obtaining-credentials) | +| client_secret | | Yes | Copied from the "Client secret" field on the Credentials page as described above in [Obtaining Credentials](#obtaining-credentials) | +| calendar_name | | Yes | This is the name you gave to your Google Calendar, or the word 'primary' if you want to use your default Google calendar (not recommended). The service will download calendar events from this calendar. | +| filter | | No | The filter criteria by which calendar events are searched. The Google Calendar API will do a text search to find calendar events that match the supplied terms. All calendar event fields are searched, except for extended properties. | +| refresh | 900000 | No | the frequency (in milliseconds) with which the Google calendar will be checked for calendar events (900000 milliseconds is 15 minutes). If you change this value, you must restart the service. | + +After the first start, you need to authorize openHAB to allow use your calendar. Follow the instructions that appear in the openHAB log. At the `openhab>` prompt, enter `log:tail`, or at the shell prompt enter `tail -f /path/to/your/openhab.log`. + +``` +[INFO ] [g.internal.GCalEventDownloader] -################################################################################################ +[INFO ] [g.internal.GCalEventDownloader] - # Google-Integration: U S E R I N T E R A C T I O N R E Q U I R E D !! +[INFO ] [g.internal.GCalEventDownloader] - # 1. Open URL 'https://www.google.com/device' +[INFO ] [g.internal.GCalEventDownloader] - # 2. Type provided code ZPWT-UVXXS +[INFO ] [g.internal.GCalEventDownloader] - # 3. Grant openHAB access to your Google calendar +[INFO ] [g.internal.GCalEventDownloader] - # 4. openHAB will automatically detect the permissions and complete the authentication process +[INFO ] [g.internal.GCalEventDownloader] - # NOTE: You will only have 1800 mins before openHAB gives up waiting for the access!!! +[INFO ] [g.internal.GCalEventDownloader] -################################################################################################ +``` + +> If you later change your `client_id` and `client_secret` in the configuration, you will have to locate and delete the file `gcal_oauth2_token`, and stop and restart the service. This is because the Google Calendar Scheduler does not detect that the OAuth token is no longer valid. On openHAB 2.0.0 installed via `apt-get`, this file is located in the directory `/var/lib/openhab2/gcal`. + +## Calendar Event Configuration + +When creating or modifying an event on the calendar, its title can be anything, and its event description must contain the instructions in the following format: + +``` +start { + send|update +} +end { + send|update +} +``` + +or just + +``` +send|update +``` + +The commands in the `start` section will be executed at the event start time and the `end` section at the event end time. If these sections are not present, the commands will be executed at the event start time. + +As a result, your lines in a calendar event might look like this: + +``` +start { + send Light_Garden ON + send Pump_Garden ON +} +end { + send Light_Garden OFF + send Pump_Garden OFF +} +``` + +or just: + +``` +send Light_Garden ON +send Pump_Garden ON +``` + +If the event description is entirely blank, then the event's start and end times are used to exclude that time period from processing. + +> :warning: The calendar must not contain any events that do not conform to the above description, including public holidays, birthdays, any all-day events at all, personal calendar entries, etc. It is recommended that you create a Google Calendar that is dedicated to the use of the Google Calendar Scheduler service. Alternatively, careful use of the `filter` configuration parameter can be used to select only a subset of matching events on the calendar. + +## Presence Simulation + +The Google Calendar Presence Simulator is an openHAB Persistence service can be used to realize a simple but effective presence simulation feature (thanks Ralf for providing the concept). Every single change of an item that belongs to a certain group is posted as new calendar entry in the future. By default each entry is posted with an offset of 14 days (If you'd like to change the offset please change the parameter `offset` in your `services/gcal-persistence.cfg` file). Each calendar entry looks like the following: + +* title: `[PresenceSimulation] ` +* content: `send ` + +To make use of Presence Simulation you have to walk through these configuration steps: + +* configure the gcal-persistence bundle by adding the appropriate configuration. You must add only calendar_name. If you want to use your primary calendar just use the keyword `primary`. All other credentials are shared from Google Calendar Scheduler configuration. +* make sure your items file contains items that belong to the group `G_PresenceSimulation` - if you would like to change the group name, change it in `persistence/gcal.persist`. +* make sure one of your items files contains an item called `PresenceSimulation`. If you would like to change the group name please change the parameter `executescript` in your `services/gcal-persistence.cfg` file. +* make sure the referenced Google Calendar is writeable by the given user at google.com. + +Note: you also need to configure the Google Calendar Scheduler to be able to read the entries from the calendar and act on them. + +To activate the Presence Simulation simply set `PresenceSimulation` to `ON` and the already downloaded events are being executed. Items in your smart home will then behave like they did 14 days earlier. + +A sample `persist/gcal.persist` file looks like this: + +``` +Strategies { + default = everyChange +} + +Items { + G_PresenceSimulation* : strategy = everyChange +} +``` + +### Solving Google Calendar Presence Simulation errors + +To solve any issues with any service bundle, increase the logging. At the `openhab>` prompt you can enter: + +``` +log:set TRACE org.openhab.persistence.gcal +log:set TRACE org.openhab.io.gcal +``` + +You can later return them to `DEFAULT` or `INFO` level. + +* "GCal PresenceSimulation Service isn't initialized properly! No entries will be uploaded to your Google Calendar" + + The persistence configuration is not correct; check that the `client_id` and `client_secret` are correct in the gcal configuration. + +* "creating a new calendar entry throws an exception: Forbidden" + + This can have several causes: + + * The `client_id` or `client_secret` might not be correct. + + * The calendar name is not correct. + + * If your not using your own calendar, make sure the sharing settings are correct and the user has sufficient rights to create calendar entries. diff --git a/concepts/things.md b/concepts/things.md index b9b413c75..077bac9d0 100644 --- a/concepts/things.md +++ b/concepts/things.md @@ -22,13 +22,13 @@ Each thing has a status object, which helps to identify possible problems with t | Status | Description | |---------------|-------------| -| UNINITIALIZED | This is the initial status of a thing, when it is added or the framework is being started. This status is also assigned, if the initializing process failed or the binding is not available. Commands, which are sent to channels will not be processed. -| INITIALIZING | This state is assigned while the binding initializes the thing. It depends on the binding how long the initializing process takes. Commands, which are sent to channels will not be processed. +| UNINITIALIZED | This is the initial status of a thing, when it is added or the framework is being started. This status is also assigned, if the initializing process failed or the binding is not available. Commands, which are sent to channels will not be processed. | +| INITIALIZING | This state is assigned while the binding initializes the thing. It depends on the binding how long the initializing process takes. Commands, which are sent to channels will not be processed. | | UNKNOWN | The handler is fully initialized but due to the nature of the represented device/service it cannot really tell yet whether the thing is ONLINE or OFFLINE. Therefore the thing potentially might be working correctly already and may or may not process commands. But the framework is allowed to send commands, because some radio-based devices may go ONLINE if a command is sent to them. The handler should take care to switch the thing to ONLINE or OFFLINE as soon as possible and then must not switch back to UNKNOWN. | -| ONLINE | The device/service represented by a thing is assumed to be working correctly and can process commands. -| OFFLINE | The device/service represented by a thing is assumed to be not working correctly and may not process commands. But the framework is allowed to send commands, because some radio-based devices may go back to ONLINE, if a command is sent to them. -| REMOVING | The device/service represented by a thing should be removed, but the binding did not confirm the deletion yet. Some bindings need to communicate with the device to unpair it from the system. Thing is probably not working and commands can not be processed. -| REMOVED | This status indicates, that the device/service represented by a thing was removed from the external system. Usually this status is an intermediate status, because the thing is removed from the database after this status is assigned. +| ONLINE | The device/service represented by a thing is assumed to be working correctly and can process commands. | +| OFFLINE | The device/service represented by a thing is assumed to be not working correctly and may not process commands. But the framework is allowed to send commands, because some radio-based devices may go back to ONLINE, if a command is sent to them. | +| REMOVING | The device/service represented by a thing should be removed, but the binding did not confirm the deletion yet. Some bindings need to communicate with the device to unpair it from the system. Thing is probably not working and commands can not be processed. | +| REMOVED | This status indicates, that the device/service represented by a thing was removed from the external system. Usually this status is an intermediate status, because the thing is removed from the database after this status is assigned. | The statuses UNINITIALIZED, INITIALIZING and REMOVING are set by the framework, where as the statuses UNKNOWN, ONLINE, OFFLINE and REMOVED are assigned from a binding. @@ -51,7 +51,7 @@ A status is detailed further with a status detail object. The following table li - +
PropertyRequiredDescription
connectionmandatory
idoptional
HANDLER_CONFIGURATION_PENDINGThe handler is registered but can not be initialized caused by missing configuration parameters.
HANDLER_INITIALIZING_ERRORThe handler failed in the initialization phase.
INITIALIZING NONENo further status details available.
UNKNOWN NONENo further status details available.
UNKNOWN NONENo further status details available.
ONLINE NONENo further status details available.
CONFIGURATION_PENDINGThe thing is waiting to transfer configuration information to a device. Some bindings need to communicate with the device to make sure the configuration is accepted.
OFFLINE NONENo further status details available.