-
Notifications
You must be signed in to change notification settings - Fork 0
Http Binding
Documentation of the HTTP binding Bundle
The HTTP binding bundle is available as a separate (optional) download.
If you want to let openHAB request an URL when special events occur or let it poll a given URL frequently, please place this bundle in the folder ${openhab_home}/addons
and add binding information to your configuration. See the following sections on how to do this.
In order to bind an item to a HTTP request, you need to provide configuration settings. The easiest way to do so is to add some binding information in your item file (in the folder configurations/items`). The syntax for the HTTP binding configuration string is explained here:
in: http:"<[<url>:<refreshintervalinmilliseconds>:<transformationrule>]"
out: http:">[<command>:<httpmethod>:<url>]"
For the !OutBinding there are two special commands available:
- '
*
' - which means the following URL is called regardless which command has been issued - 'CHANGED' - which means the following URL is called whenever the state of the given item changed
Here are some examples of valid binding configuration strings:
http=">[ON:POST:http://www.domain.org/home/lights/23871/?status=on&type=\"text\"] >[OFF:POST:http://www.domain.org/home/lights/23871/?status=off]"
http="<[http://www.domain.org/weather/openhabcity/daily:60000:REGEX(.*?<title>(.*?)</title>.*)]"
http=">[ON:POST:http://www.domain.org/home/lights/23871/?status=on&type=\"text\"] >[OFF:POST:http://www.domain.org/home/lights/23871/?status=off]"
http=">[*:POST:http://www.domain.org/home/lights/23871/?status=%2$s&type=\"text\"] <[http://www.domain.org/weather/openhabcity/daily:60000:REGEX(.*?<title>(.*?)</title>.*)]"
http=">[CHANGED:POST:http://www.domain.org/home/lights/23871/?status=%2$s&date=%1$tY-%1$tm-%1$td]"
As a result, your lines in the items file might look like the following:
Number Weather_Temperature "Temperature [%.1f °C]" <temperature> (Weather) { http="<[http://weather.yahooapis.com/forecastrss?w=638242&u=c:60000:XSLT(demo_yahoo_weather.xsl)]" }
openHAB supports several types of transformations.
XSLT transformations
In most cases, you will get the information you need into a XML structured document, and you need a way to extract only the value you want: here is where XSLT transformations come in our help.
The given URL can be enhanced using the well known Syntax of the java.util.Formatter. The !HttpOutBinding currently adds to parameters to the String.format() automatically
- the current date (as java.util.Date)
- the current Command or State
To reference these values the indexed format syntax is used. A well prepared URL look like this:
http://www.domain.org/home/lights/23871/?status=%2$s&date=%1$tY-%1$tm-%1$td
Each format string starts with '%' followed by an optional index e.g. '2$' whereas '2' is the index of the parameter arg given to the format(format, args...) method. Besides the index you have to specify the format to be applied to the argument. E.g. 's' to format a String in the given example or 'd' to format an Integer, or '.1f' to format a Float with one decimal fraction.
Both !OutBinding and !InBinding provide the possibility to define optional HTTP headers, which will be sent during the HTTP method call. Those optional headers can be added to the url in the form header1=value1&header2=value2....
This headers string should be enclosed in curly brackets right after the url itself (before the separation colon).
Example:
http="<[https://www.flukso.net/api/sensor/xxxx?interval=daily{X-Token=mytoken&X-version=1.0}:60000:REGEX(.*?<title>(.*?)</title>(.*))]"
Javascript transforms can be used to parse JSON input. First, define your item:
String DirecTV1_Ch "Current Channel" { http="<[http://10.90.30.100:8080/tv/getTuned:30000:JS(getValue.js)]" }
Then you put a file getValue.js
in $OPENHAB_DIR/configuration/transform/
The content of getValue.js is:
JSON.parse(input).title;
Since v1.3, HTTP binding support page caching. Caching is usable, when multiple items could be parsed from the same URL.
Cache functionality can be configured in the openhab.cfg file (in the folder '${openhab_home}/configurations').
############################### HTTP Binding ##########################################
# URL of the first cache item
# http:<cacheItemName1>.url=
# Update interval for first cache item
# http:<cacheItemName1>.updateInterval=
# URL of the second cache item
# http:<cacheItemName2>.url=
# Update interval for second cache item
# http:<cacheItemName2>.updateInterval=
The http:<cacheItemName1>.url
value is the valid URL.
The http:<cacheItemName1>.updateInterval
value is update interval in milliseconds.
Examples, how to configure your HTTP cache item:
####Configuration:
http:weatherCache.url=http://weather.yahooapis.com/forecastrss?w=566473&u=c
http:weatherCache.updateInterval=60000
####Items:
Number temperature { http="<[weatherCache:10000:XSLT(demo_yahoo_weather_temperature.xsl)]" }
Number windSpeed { http="<[weatherCache:10000:XSLT(demo_yahoo_weather_wind_speed.xsl)]" }
Installation
Community
- Support
- News Archive
- Presentations
- How to Contribute
- IDE Setup
- How to Implement a Binding
- How to Implement an Action
- Projects using openHAB
- User Interfaces
- Classic UI
- iOS Client
- Android Client
- GreenT UI
- CometVisu
- Automation
- Scripts
- Rules
- Actions
- Bindings
- AlarmDecoder Binding
- Anel Binding
- Asterisk Binding
- Astro Binding
- BenQ Projector Binding
- Bluetooth Binding
- Comfo Air Binding
- Config Admin Binding
- CUL Binding
- CUPS Binding
- DAIKIN Binding
- Davis Binding
- digitalSTROM Binding
- DMX512 Binding
- DSC Alarm Binding
- DSMR Binding
- Ecobee Binding
- EDS OWSever Binding
- eKey Binding
- Energenie Binding
- EnOcean Binding
- Epson Projector Binding
- Exec Binding
- Freebox Binding
- Freeswitch Binding
- Fritz AHA Binding
- Fritz!Box Binding
- FS20 Binding
- Global Cache IR Binding
- GPIO Binding
- HAI/Leviton OmniLink Binding
- HDAnywhere Binding
- Heatmiser Binding
- Homematic / Homegear Binding
- HTTP Binding
- IEC 62056-21 Binding
- IHC / ELKO Binding
- ImperiHome Binding
- Insteon Hub Binding
- Insteon PLM Binding
- IRtrans Binding
- jointSPACE-Binding
- KNX Binding
- Koubachi Binding
- Leviton/HAI Omnilink Binding
- Lg TV Binding
- MAX!Cube-Binding
- MAX! CUL Binding
- MiLight Binding
- MiOS Binding
- Modbus TCP Binding
- MPD Binding
- MQTT Binding
- MQTTitude binding
- Neohub Binding
- Nest Binding
- Netatmo Binding
- Network Health Binding
- Network UPS Tools Binding
- Nibe Heatpump Binding
- Nikobus Binding
- Novelan/Luxtronic Heatpump Binding
- NTP Binding
- One-Wire Binding
- Onkyo AV Receiver Binding
- Open Energy Monitor Binding
- OpenPaths presence detection binding
- OpenSprinkler Binding
- OSGi Configuration Admin Binding
- Philips Hue Binding
- Piface Binding
- pilight Binding
- Pioneer-AVR-Binding
- Plugwise Binding
- PLCBus Binding
- Primare Binding
- Pulseaudio Binding
- RFXCOM Binding
- Samsung AC Binding
- Samsung TV Binding
- Serial Binding
- Satel Alarm Binding
- Snmp Binding
- Somfy URTSI II Binding
- Sonos Binding
- Squeezebox Binding
- Swegon ventilation Binding
- System Info Binding
- TCP/UDP Binding
- Tellstick Binding
- TinkerForge Binding
- Tivo Binding
- VDR Binding
- Velleman-K8055-Binding
- Wake-on-LAN Binding
- Waterkotte EcoTouch Heatpump Binding
- Weather Binding
- Wemo Binding
- Withings Binding
- XBMC Binding
- xPL Binding
- Yamahareceiver Binding
- Zibase Binding
- Z-Wave Binding
- Application Integration
- Asterisk
- Google Calendar
- Linux Media Players
- ROS Robot Operating System
- Telldus Tellstick
- Zoneminder
- Rooted Wink Hub
- Persistence
- db4o Persistence
- rrd4j Persistence
- MySQL Persistence
- MongoDB Persistence
- Sen.Se Persistence
- Cosm Persistence
- Logging Persistence
- Exec Persistence
- MQTT Persistence
- InfluxDB Persistence
- JPA Persistence
- Misc
- Transformations
- REST-API
- Security
- Service Discovery
- Dropbox Bundle
- Voice Control
Samples
- Item definitions
- Sitemap definitions
- Binding configurations
- Comfo Air Binding
- Nest Binding (new)
- Nest Thermostat
- Rollershutter Groups
- Squeezebox
- WAC Binding
- WebSolarLog
- Rules
- Misc. rule examples
- Alarm Clock
- Convert Farenheit to Celcius
- Taking Rules to New Heights
- Reusable Rules via Functions
- Items, Rules and more Examples of a SmartHome
- REST Examples
- Tips and Tricks
- Scripts
- Syntax highlighting for external editors
- Update-Scripts
- Controlling openHAB with Android
- Usecase examples
Release Notes