1253 lines
61 KiB
HTML
1253 lines
61 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
||
|
||
|
||
|
||
<!--<link rel="shortcut icon" href="https://www.openhab.org/favicon.png"></link>-->
|
||
<title>Actions - openHAB 2 - Empowering the Smart Home</title>
|
||
|
||
<!-- CSS -->
|
||
<link type="text/css" rel="stylesheet" href="/v2.1/css/materialize.css" media="screen,projection" />
|
||
<link type="text/css" rel="stylesheet" href="/v2.1/css/pygments-jekyll-style.css" />
|
||
<link type="text/css" rel="stylesheet" href="/v2.1/css/styles.css" />
|
||
<link type="text/css" rel="stylesheet" href="/v2.1/css/openhab.css" />
|
||
<link type="text/css" rel="stylesheet" href="/v2.1/css/collapsible.css" />
|
||
|
||
<!-- Font -->
|
||
<link type="text/css" rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons" />
|
||
<link type="text/css" rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:300,400,700" />
|
||
<link rel="canonical" href="http://docs.openhab.org/addons/actions.html" />
|
||
<script type="text/javascript">var gaProperty = 'UA-47717934-3';var disableStr = 'ga-disable-' + gaProperty;if (document.cookie.indexOf(disableStr + '=true') > -1) {window[disableStr] = true;}</script>
|
||
<script>
|
||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||
ga('create', 'UA-47717934-3', 'auto');
|
||
ga('set', 'anonymizeIp', true);
|
||
ga('send', 'pageview');
|
||
</script>
|
||
</head>
|
||
|
||
|
||
<body class="documentation">
|
||
<div id="header" class="navbar-fixed">
|
||
<nav role="navigation">
|
||
<div class="container">
|
||
<div class="nav-wrapper">
|
||
<a href="/v2.1/index.html"><img id="logo" src="/images/logo.png" /></a>
|
||
<a href="#" data-activates="nav-mobile" class="button-collapse"><i class="material-icons">menu</i></a>
|
||
<ul class="right hide-on-med-and-down">
|
||
<li><a href="/tutorials/index.html">Tutorials</a></li>
|
||
<li><a href="/v2.1/introduction.html">User Manual</a></li>
|
||
<li><a href="/developers/index.html">Developer Guide</a></li>
|
||
<li><a target="_blank" href="https://community.openhab.org">Community Forum</a></li>
|
||
<li><a target="_blank" href="https://github.com/openhab">GitHub</a></li>
|
||
<li class="search"><i class="material-icons">search</i></li>
|
||
<li class="search">
|
||
<form method="GET" id="searchform" class="search-form" action="/search">
|
||
<input id="query" name="q" type="text" class="search-form-input" placeholder="search" />
|
||
</form>
|
||
</li>
|
||
</ul>
|
||
<ul id="nav-mobile" class="side-nav">
|
||
<li><a href="/v2.1/index.html">Home</a></li>
|
||
<li><a href="/tutorials/index.html">Tutorials</a></li>
|
||
<li><a href="/v2.1/introduction.html">User Manual</a></li>
|
||
<li><a href="/developers/index.html">Developer Guide</a></li>
|
||
<li><a target="_blank" href="https://community.openhab.org">Community Forum</a></li>
|
||
<li><a target="_blank" href="https://github.com/openhab">GitHub</a></li>
|
||
<li class="search">
|
||
<form method="GET" id="searchformmob" class="search-form" action="/search">
|
||
<input id="querymob" name="q" type="text" class="search-form-input" placeholder="search" />
|
||
</form>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
</div>
|
||
|
||
|
||
<section id="documentation" class="text content-wrapper">
|
||
<div class="container">
|
||
<div class="side-nav-wrapper">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<ul class="nav">
|
||
<li><a href="/v2.1/introduction.html">Introduction</a></li>
|
||
<li><a href="/v2.1/concepts/index.html">Concepts</a>
|
||
<ul>
|
||
<li><a href="/v2.1/concepts/index.html">Overview</a></li>
|
||
<hr />
|
||
<li><a href="/v2.1/concepts/things.html">Things</a></li>
|
||
<li><a href="/v2.1/concepts/items.html">Items</a></li>
|
||
<li><a href="/v2.1/concepts/discovery.html">Inbox & Discovery</a></li>
|
||
<li><a href="/v2.1/concepts/audio.html">Audio & Voice</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="/v2.1/installation/index.html">Installation</a>
|
||
<ul>
|
||
<li><a href="/v2.1/installation/index.html">Overview</a></li>
|
||
<hr />
|
||
<li><a href="/v2.1/installation/linux.html">Linux</a></li>
|
||
<li><a href="/v2.1/installation/windows.html">Windows</a></li>
|
||
<li><a href="/v2.1/installation/macosx.html">Mac OS X</a></li>
|
||
<hr />
|
||
<li><a href="/v2.1/installation/openhabian.html">openHABian</a></li>
|
||
<li><a href="/v2.1/installation/docker.html">Docker</a></li>
|
||
<hr />
|
||
<li><a href="/v2.1/installation/rasppi.html">Raspberry Pi</a></li>
|
||
<li><a href="/v2.1/installation/pine.html">Pine A64</a></li>
|
||
<li><a href="/v2.1/installation/synology.html">Synology DiskStation</a></li>
|
||
<li><a href="/v2.1/installation/qnap.html">QNAP NAS</a></li>
|
||
<hr />
|
||
<li><a href="/v2.1/installation/designer.html">SmartHome Designer</a></li>
|
||
<li><a href="/v2.1/installation/security.html">Security & Remote Access</a></li>
|
||
<li><a href="http://www.myopenhab.org">myopenHAB</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="/v2.1/configuration/index.html">Configuration</a>
|
||
<ul>
|
||
<li><a href="/v2.1/configuration/index.html">Overview</a></li>
|
||
<hr />
|
||
<li><a href="/v2.1/configuration/things.html">Things</a></li>
|
||
<li><a href="/v2.1/configuration/items.html">Items</a></li>
|
||
<li><a href="/v2.1/configuration/sitemaps.html">Sitemaps</a></li>
|
||
<li><a href="/v2.1/configuration/transform.html">Transformations</a></li>
|
||
<li><a href="/v2.1/configuration/persistence.html">Persistence</a></li>
|
||
<li><a href="/v2.1/configuration/rules-dsl.html">Rules</a></li>
|
||
<li><a href="/v2.1/configuration/services.html">Services</a></li>
|
||
<hr />
|
||
<li><a href="/v2.1/configuration/packages.html">Initial Setup Packages</a></li>
|
||
<li><a href="/v2.1/configuration/paperui.html">Paper UI</a></li>
|
||
<li><a href="/v2.1/configuration/habmin.html">HABmin</a></li>
|
||
<li><a href="/v2.1/configuration/rules-ng.html">Rules (Experimental)</a></li>
|
||
<hr />
|
||
<li><a href="/v2.1/configuration/multimedia.html">Audio & Voice</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="/v2.1/addons/index.html">Add-ons</a>
|
||
<ul>
|
||
<li><a href="/v2.1/addons/index.html">Overview</a></li>
|
||
<hr />
|
||
<li><a href="/v2.1/addons/bindings.html">Bindings</a>
|
||
<ul>
|
||
<li><a href="/v2.1/addons/bindings.html">Overview</a></li>
|
||
<hr />
|
||
|
||
<li><a href="/v2.1/addons/bindings/airquality/readme.html">Air Quality</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/akm8681/readme.html">AKM868</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/alarmdecoder1/readme.html">Alarm Decoder</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/allplay/readme.html">AllPlay</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/amazondashbutton/readme.html">Amazon Dash Button</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/anel1/readme.html">Anel NET-PwrCtrl</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/asterisk1/readme.html">Asterisk</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/astro/readme.html">Astro</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/astro1/readme.html">Astro</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/atlona/readme.html">Atlona</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/autelis/readme.html">Autelis Pool Control</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/autelis1/readme.html">Autelis</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/avmfritz/readme.html">AVM FRITZ!</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/benqprojector1/readme.html">BenQ Projector</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/bigassfan/readme.html">BigAssFan</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/bluetooth1/readme.html">Bluetooth</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/boschindego/readme.html">Bosch Indego</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/bticino1/readme.html">Bticino</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/caldav-command1/readme.html">CalDAV Command</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/caldav-personal1/readme.html">CalDAV Personal</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/chromecast/readme.html">Chromecast</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/comfoair1/readme.html">ComfoAir</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/configadmin1/readme.html">ConfigAdmin</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/coolmasternet/readme.html">CoolMasterNet</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/cups1/readme.html">CUPS</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/daikin1/readme.html">Daikin</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/davis1/readme.html">Davis</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/ddwrt1/readme.html">DD-WRT</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/denon1/readme.html">Denon</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/digitalstrom/readme.html">digitalSTROM</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/digitalstrom1/readme.html">digitalSTROM</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/diyonxbee1/readme.html">DIYOnXBee</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/dlinksmarthome/readme.html">D-Link Smart Home</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/dmx1/readme.html">DMX</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/dscalarm/readme.html">DSC Alarm</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/dscalarm1/readme.html">DSC PowerSeries Alarm System</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/dsmr1/readme.html">DSMR</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/ebus1/readme.html">eBUS</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/ecobee1/readme.html">Ecobee</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/ecotouch1/readme.html">EcoTouch</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/ekey1/readme.html">ekey</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/energenie1/readme.html">Energenie</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/enocean1/readme.html">EnOcean</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/enphaseenergy1/readme.html">Enphase Energy</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/epsonprojector1/readme.html">Epson Projector</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/exec/readme.html">Exec</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/exec1/readme.html">Exec</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/expire1/readme.html">Expire</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/fatekplc1/readme.html">Fatek PLC</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/feed/readme.html">Feed</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/fht1/readme.html">FHT</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/folding/readme.html">Folding@home</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/freebox/readme.html">Freebox</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/freebox1/readme.html">Freebox</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/freeswitch1/readme.html">FreeSWITCH</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/fritzaha1/readme.html">Fritz AHA</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/fritzbox1/readme.html">Fritz!Box</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/fritzboxtr0641/readme.html">Fritzbox (using TR064 protocol)</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/frontiersiliconradio1/readme.html">Frontier Silicon Radio</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/fs201/readme.html">FS20</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/fsinternetradio/readme.html">FS Internet Radio</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/garadget1/readme.html">Garadget</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/gardena/readme.html">Gardena</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/gc100ir1/readme.html">Global Cache IR</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/globalcache/readme.html">GlobalCache</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/gpio1/readme.html">GPIO</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/harmonyhub/readme.html">Logitech Harmony Hub</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/harmonyhub1/readme.html">Harmony Hub</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/hdanywhere/readme.html">HDanywhere</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/hdanywhere1/readme.html">HDanywhere</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/hdpowerview/readme.html">Hunter Douglas PowerView</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/heatmiser1/readme.html">Heatmiser</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/hms1/readme.html">HMS</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/homematic/readme.html">Homematic</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/homematic1/readme.html">Homematic</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/horizon1/readme.html">Horizon mediabox</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/http1/readme.html">HTTP</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/hue/readme.html">Philips Hue</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/hue1/readme.html">Hue</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/iec6205621meter1/readme.html">IEC 62056-21 Meter</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/ihc1/readme.html">IHC / ELKO</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/insteonhub1/readme.html">Insteon Hub</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/insteonplm1/readme.html">Insteon PLM</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/intertechno1/readme.html">Intertechno</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/ipp/readme.html">IPP</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/ipx8001/readme.html">IPX800</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/irtrans1/readme.html">IRTrans</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/isy1/readme.html">Description</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/jointspace1/readme.html">jointSPACE</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/k80551/readme.html">Velleman k8055 USB IO Board</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/keba/readme.html">Keba</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/km2001/readme.html">KM200</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/knx1/readme.html">KNX</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/kodi/readme.html">Kodi</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/kostalinverter/readme.html">Kostal Inverter</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/koubachi1/readme.html">Koubachi</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/lcn1/readme.html">LCN</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/lgtv1/readme.html">LG TV</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/lgtvserial/readme.html">LG TV control using serial protocol</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/lifx/readme.html">LIFX</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/lightwaverf1/readme.html">LightwaveRF</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/lutron/readme.html">Lutron</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/mailcontrol1/readme.html">MailControl</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/max/readme.html">MAX!</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/maxcube1/readme.html">MAX!Cube</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/maxcul1/readme.html">MAX!CUL</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/mcp230171/readme.html">MCP23017</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/mcp34241/readme.html">MCP3424</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/meteostick/readme.html">Meteostick</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/miele/readme.html">Miele@home</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/mihome/readme.html">Xiaomi Mi Smart Home</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/milight/readme.html">Milight/Easybulb/Limitless</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/milight1/readme.html">Milight</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/minecraft/readme.html">Minecraft</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/mios1/readme.html">MiOS Bridge</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/mochadx101/readme.html">Mochad X10</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/modbus1/readme.html">Modbus</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/mpd1/readme.html">MPD</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/mqtt1/readme.html">MQTT</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/mqttitude1/readme.html">OwnTracks (formerly MQTTitude)</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/myq1/readme.html">Chamberlain MyQ</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/mystromecopower1/readme.html">Mystrom Eco Power</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/neohub1/readme.html">NeoHub</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/nest1/readme.html">Nest</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/netatmo/readme.html">Netatmo</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/netatmo1/readme.html">Netatmo</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/network/readme.html">Network</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/networkhealth1/readme.html">Network Health</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/networkupstools1/readme.html">Network UPS Tools</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/nibeheatpump1/readme.html">Nibe Heatpump</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/nikobus1/readme.html">Nikobus</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/nikohomecontrol/readme.html">Niko Home Control</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/novelanheatpump1/readme.html">Novelan/Luxtronic Heat Pump</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/ntp/readme.html">NTP</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/ntp1/readme.html">Network Time Protocol (NTP)</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/oceanic/readme.html">Oceanic</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/omnilink1/readme.html">HAI/Leviton Omni and Lumina</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/onebusaway/readme.html">OneBusAway</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/onewire1/readme.html">OneWire</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/onkyo/readme.html">Onkyo</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/onkyo1/readme.html">Onkyo AV Receiver</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/openenergymonitor1/readme.html">Open Energy Monitor</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/openpaths1/readme.html">OpenPaths</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/opensprinkler/readme.html">OpenSprinkler</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/opensprinkler1/readme.html">OpenSprinkler</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/orvibo/readme.html">Orvibo</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/owserver1/readme.html">OWServer</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/panasonictv1/readme.html">Panasonic TV</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/panstamp1/readme.html">panStamp</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/piface1/readme.html">Piface</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/pilight1/readme.html">pilight</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/pioneeravr/readme.html">PioneerAVR Configuration</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/pioneeravr1/readme.html">Pioneer AV Receiver (1.x)</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/plcbus1/readme.html">PLCBus</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/plclogo1/readme.html">PLCLogo</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/plex1/readme.html">Plex</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/plugwise1/readme.html">Plugwise</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/powerdoglocalapi1/readme.html">PowerDog Local API</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/powermax1/readme.html">Visonic Powermax</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/primare1/readme.html">Primare</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/pulseaudio/readme.html">Pulseaudio</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/pulseaudio1/readme.html">Pulseaudio</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/rfxcom/readme.html">RFXCOM</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/rfxcom1/readme.html">RFXCOM</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/rme/readme.html">RME</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/rpircswitch1/readme.html">Raspberry Pi RC Switch</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/russound/readme.html">Russound</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/rwesmarthome1/readme.html">RWE SmartHome</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/sagercaster1/readme.html">Sager Weathercaster</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/sallegra1/readme.html">Sallegra</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/samsungac1/readme.html">Samsung Air Conditioner</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/samsungtv/readme.html">Samsung TV</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/samsungtv1/readme.html">Samsung TV</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/sapp1/readme.html">Picnet Sapp</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/satel1/readme.html">Satel Integra Alarm System</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/sensebox/readme.html">senseBox</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/serial1/readme.html">Serial</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/silvercrestwifisocket/readme.html">Silvercrest Wifi Plug</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/sleepiq/readme.html">SleepIQ</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/smaenergymeter/readme.html">SMA Energy Meter</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/smarthomatic1/readme.html">Smarthomatic</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/snmp1/readme.html">SNMP</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/sonance1/readme.html">Sonance</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/sonos/readme.html">Sonos</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/sonos1/readme.html">Sonos</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/souliss1/readme.html">Souliss</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/squeezebox/readme.html">Logitech Squeezebox</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/squeezebox1/readme.html">Squeezebox</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/stiebelheatpump1/readme.html">Stiebel Eltron LWZ</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/swegonventilation1/readme.html">Swegon Ventilation</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/synopanalyzer/readme.html">Synop Analyzer</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/systeminfo/readme.html">Systeminfo</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/systeminfo1/readme.html">System Information</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/tacmi1/readme.html">TACmi</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/tankerkoenig/readme.html">Tankerkönig</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/tcp1/readme.html">TCP & UDP</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/tellstick/readme.html">Tellstick</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/tellstick1/readme.html">Tellstick</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/tesla/readme.html">Tesla</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/tinkerforge1/readme.html">TinkerForge</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/tivo1/readme.html">TiVo</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/toon/readme.html">Toon</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/tradfri/readme.html">Trådfri</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/ucprelayboard1/readme.html">UCProjects.eu Relay Board</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/upb1/readme.html">UPB</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/urtsi/readme.html">Somfy URTSI II</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/urtsi1/readme.html">Somfy URTSI II</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/vdr1/readme.html">Video Disk Recorder (VDR)</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/vitotronic/readme.html">Vitotronic</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/wago1/readme.html">WAGO</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/weather1/readme.html">Weather</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/wemo/readme.html">Belkin Wemo</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/wemo1/readme.html">Wemo</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/wifiled/readme.html">WiFi LED</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/windcentrale/readme.html">Windcentrale</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/withings1/readme.html">Withings</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/wol1/readme.html">Wake-on-LAN</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/wr32231/readme.html">WR3223 ventilation controller</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/xbmc1/readme.html">XBMC binding (for KODI) (1.x)</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/xpl1/readme.html">xPL</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/yahooweather/readme.html">YahooWeather</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/yamahareceiver/readme.html">Yamahareceiver</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/yamahareceiver1/readme.html">Yamaha Receiver (1.x)</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/zibase1/readme.html">Zibase</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/zigbee/readme.html">ZigBee</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/zoneminder/readme.html">Zoneminder</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/zwave/readme.html">ZWave</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/zwave1/readme.html">Z-Wave</a></li>
|
||
|
||
<li><a href="/v2.1/addons/bindings/zway/readme.html">Z-Way</a></li>
|
||
|
||
</ul>
|
||
</li>
|
||
<li><a href="/v2.1/addons/uis.html">User Interfaces</a>
|
||
<ul>
|
||
<li><a href="/v2.1/addons/uis.html">Overview</a></li>
|
||
<hr />
|
||
|
||
<li><a href="/v2.1/addons/uis/basic/readme.html">Basic UI</a></li>
|
||
|
||
<li><a href="/v2.1/addons/uis/classic/readme.html">Classic UI</a></li>
|
||
|
||
<li><a href="/v2.1/addons/uis/habmin/readme.html">HABmin</a></li>
|
||
|
||
<li><a href="/v2.1/addons/uis/habpanel/readme.html">HABPanel</a></li>
|
||
|
||
<li><a href="/v2.1/addons/uis/paper/readme.html">Paper UI</a></li>
|
||
|
||
<hr />
|
||
<li><a href="/v2.1/addons/uis/apps/android.html">Android openHAB App</a></li>
|
||
<li><a href="/v2.1/addons/uis/apps/ios.html">iOS openHAB App</a></li>
|
||
<li><a href="/v2.1/addons/uis/apps/windows.html">Windows 10 openHAB App</a></li>
|
||
<hr />
|
||
<li><a href="/v2.1/addons/iconsets/classic/readme.html">Iconset (classic)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="/v2.1/addons/persistence.html">Persistence</a>
|
||
<ul>
|
||
<li><a href="/v2.1/addons/persistence.html">Overview</a></li>
|
||
<hr />
|
||
|
||
<li><a href="/v2.1/addons/persistence/caldav/readme.html">CalDAV</a></li>
|
||
|
||
<li><a href="/v2.1/addons/persistence/cosm/readme.html">Xively (formerly Cosm)</a></li>
|
||
|
||
<li><a href="/v2.1/addons/persistence/db4o/readme.html">db4o</a></li>
|
||
|
||
<li><a href="/v2.1/addons/persistence/dynamodb/readme.html">Amazon DynamoDB</a></li>
|
||
|
||
<li><a href="/v2.1/addons/persistence/exec/readme.html">Exec</a></li>
|
||
|
||
<li><a href="/v2.1/addons/persistence/influxdb/readme.html">InfluxDB (0.9 and newer)</a></li>
|
||
|
||
<li><a href="/v2.1/addons/persistence/influxdb08/readme.html">InfluxDB (up to 0.8.x)</a></li>
|
||
|
||
<li><a href="/v2.1/addons/persistence/jdbc/readme.html">JDBC</a></li>
|
||
|
||
<li><a href="/v2.1/addons/persistence/jpa/readme.html">Java Persistence API (JPA)</a></li>
|
||
|
||
<li><a href="/v2.1/addons/persistence/mapdb/readme.html">mapdb</a></li>
|
||
|
||
<li><a href="/v2.1/addons/persistence/mongodb/readme.html">MongoDB</a></li>
|
||
|
||
<li><a href="/v2.1/addons/persistence/mqtt/readme.html">MQTT</a></li>
|
||
|
||
<li><a href="/v2.1/addons/persistence/mysql/readme.html">MySQL</a></li>
|
||
|
||
<li><a href="/v2.1/addons/persistence/rrd4j/readme.html">rrd4j</a></li>
|
||
|
||
<li><a href="/v2.1/addons/persistence/sense/readme.html">Sen.Se</a></li>
|
||
|
||
<li><a href="/v2.1/addons/persistence/sitewhere/readme.html">SiteWhere</a></li>
|
||
|
||
</ul>
|
||
</li>
|
||
<li><a href="/v2.1/addons/actions.html">Actions</a>
|
||
<ul>
|
||
<li><a href="/v2.1/addons/actions.html">Overview</a></li>
|
||
<hr />
|
||
|
||
<li><a href="/v2.1/addons/actions/astro/readme.html">Astro</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/ciscospark/readme.html">Cisco Spark</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/dscalarm/readme.html">DSC Alarm</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/ecobee/readme.html">Ecobee</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/harmonyhub/readme.html">Logitech Harmony Hub</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/homematic/readme.html">Homematic</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/mail/readme.html">Mail</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/mios/readme.html">MiOS</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/mqtt/readme.html">MQTT</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/nma/readme.html">NotifyMyAndroid</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/openwebif/readme.html">OpenWebIf</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/pebble/readme.html">Pebble</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/prowl/readme.html">Prowl</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/pushover/readme.html">Pushover</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/pushsafer/readme.html">Pushsafer</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/satel/readme.html">Satel</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/squeezebox/readme.html">Squeezebox</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/telegram/readme.html">Telegram</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/tinkerforge/readme.html">TinkerForge</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/twitter/readme.html">Twitter</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/weather/readme.html">Weather</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/xbmc/readme.html">XBMC</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/xmpp/readme.html">XMPP</a></li>
|
||
|
||
<li><a href="/v2.1/addons/actions/xpl/readme.html">xPL</a></li>
|
||
|
||
</ul>
|
||
</li>
|
||
<li><a href="/v2.1/addons/transformations.html">Transformations</a>
|
||
<ul>
|
||
<li><a href="/v2.1/addons/transformations.html">Overview</a></li>
|
||
<hr />
|
||
|
||
<li><a href="/v2.1/addons/transformations/exec/readme.html">Exec</a></li>
|
||
|
||
<li><a href="/v2.1/addons/transformations/javascript/readme.html">JavaScript</a></li>
|
||
|
||
<li><a href="/v2.1/addons/transformations/jsonpath/readme.html">JsonPath</a></li>
|
||
|
||
<li><a href="/v2.1/addons/transformations/map/readme.html">Map</a></li>
|
||
|
||
<li><a href="/v2.1/addons/transformations/regex/readme.html">RegEx</a></li>
|
||
|
||
<li><a href="/v2.1/addons/transformations/scale/readme.html">Scale</a></li>
|
||
|
||
<li><a href="/v2.1/addons/transformations/xpath/readme.html">XPath</a></li>
|
||
|
||
<li><a href="/v2.1/addons/transformations/xslt/readme.html">XSLT</a></li>
|
||
|
||
</ul>
|
||
</li>
|
||
<li><a href="/v2.1/addons/voice.html">Voice Services</a>
|
||
<ul>
|
||
<li><a href="/v2.1/addons/voice.html">Overview</a></li>
|
||
<hr />
|
||
|
||
<li><a href="/v2.1/addons/voice/mactts/readme.html">MacOS Text-to-Speech</a></li>
|
||
|
||
<li><a href="/v2.1/addons/voice/marytts/readme.html">Mary Text-to-Speech</a></li>
|
||
|
||
<li><a href="/v2.1/addons/voice/voicerss/readme.html">VoiceRSS Text-to-Speech</a></li>
|
||
|
||
</ul>
|
||
</li>
|
||
<hr />
|
||
<li><a href="/v2.1/addons/io.html">3rd Party Integration</a>
|
||
<ul>
|
||
<li><a href="/v2.1/addons/io.html">Overview</a></li>
|
||
<hr />
|
||
|
||
<li><a href="/v2.1/addons/io/dropbox/readme.html">Dropbox Synchronization</a></li>
|
||
|
||
<li><a href="/v2.1/addons/io/gcal/readme.html">Google Calendar Scheduler</a></li>
|
||
|
||
<li><a href="/v2.1/addons/io/homekit/readme.html">HomeKit Add-on</a></li>
|
||
|
||
<li><a href="/v2.1/addons/io/hueemulation/readme.html">openHAB Hue Emulation</a></li>
|
||
|
||
<li><a href="/v2.1/addons/io/imperihome/readme.html">ImperiHome integration service</a></li>
|
||
|
||
<li><a href="/v2.1/addons/io/openhabcloud/readme.html">openHAB Cloud Connector</a></li>
|
||
|
||
<hr />
|
||
<li><a href="/v2.1/configuration/restdocs.html">REST API</a></li>
|
||
<li><a href="http://www.myopenhab.org/" target="_blank">IFTTT</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="/v2.1/administration/index.html">Advanced Functionality</a>
|
||
<ul>
|
||
<li><a href="/v2.1/administration/index.html">Overview</a></li>
|
||
<hr />
|
||
<li><a href="/v2.1/administration/console.html">Console</a></li>
|
||
<li><a href="/v2.1/administration/runtime.html">Runtime Commands</a></li>
|
||
<li><a href="/v2.1/administration/bundles.html">Bundle Management</a></li>
|
||
<li><a href="/v2.1/administration/logging.html">Logging</a></li>
|
||
<hr />
|
||
<li><a href="/v2.1/administration/jsondb.html">JsonDB Storage</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="/v2.1/appendix/help.html">Community Guidance</a>
|
||
<ul>
|
||
<li><a href="/v2.1/appendix/help.html">Finding Help & FAQs</a></li>
|
||
<li><a href="/v2.1/appendix/contributing.html">Contributing</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
<div id="versioning" class="row valign-wrapper">
|
||
<div class="col s12 right-align">
|
||
<ul id="dropdown-versioning" class="dropdown-content">
|
||
<li><a href="/v2.1/../addons/actions.html">latest version</a></li>
|
||
<li><a href="/v2.1/../v2.2/addons/actions.html">v2.2</a></li>
|
||
<li><a href="/v2.1/addons/actions.html">v2.1<i class="tiny material-icons right">lens</i></a></li>
|
||
</ul>
|
||
<a class="btn dropdown-button grey lighten-1" href="#!" data-activates="dropdown-versioning" title="Select which version of this openHAB documentation article you want to read.">
|
||
Switch Article Version<i class="material-icons right">arrow_drop_down</i>
|
||
</a>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="content">
|
||
|
||
<h1 id="actions">Actions</h1>
|
||
|
||
<p>Actions are predefined methods that are called from openHAB rules and scripts.
|
||
They are automatically imported and can be used to execute openHAB-specific operations or to send commands or data to external hardware or services. There are a set of built in core Actions and optional installable Actions.</p>
|
||
|
||
<p>The page is structured as follows:</p>
|
||
|
||
<ul id="markdown-toc">
|
||
<li><a href="#core-actions" id="markdown-toc-core-actions">Core Actions</a> <ul>
|
||
<li><a href="#event-bus-actions" id="markdown-toc-event-bus-actions">Event Bus Actions</a></li>
|
||
<li><a href="#audio-actions" id="markdown-toc-audio-actions">Audio Actions</a></li>
|
||
<li><a href="#logging-actions" id="markdown-toc-logging-actions">Logging Actions</a></li>
|
||
<li><a href="#http-actions" id="markdown-toc-http-actions">HTTP Actions</a></li>
|
||
<li><a href="#timers" id="markdown-toc-timers">Timers</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#installable-actions" id="markdown-toc-installable-actions">Installable Actions</a></li>
|
||
</ul>
|
||
|
||
<h2 id="core-actions">Core Actions</h2>
|
||
|
||
<p>The following Actions are a core part of openHAB and do not need to be separately installed.</p>
|
||
|
||
<h3 id="event-bus-actions">Event Bus Actions</h3>
|
||
|
||
<ul>
|
||
<li><code class="highlighter-rouge">sendCommand(String itemName, String commandString)</code>: Sends the given command to the specified Item to the event bus.</li>
|
||
<li><code class="highlighter-rouge">postUpdate(String itemName, String commandString)</code>: Sends the given status update to the specified Item to the event bus.</li>
|
||
</ul>
|
||
|
||
<p>When the result of the commandString is to cause some action (e.g. turn on a light, change a thermostat to a new temperature, etc.) then use sendCommand. When interacting with widgets on the user interfaces commands are sent to the Items.</p>
|
||
|
||
<p>When the result of the commandString is to change the state of an Item without causing some action (i.e. to make the state of an Item match the state of a device without commanding the device to change).</p>
|
||
|
||
<p>As a general rule, is better to call <code class="highlighter-rouge">MyItem.sendCommand(command)</code> and <code class="highlighter-rouge">MyItem.postUpdate(command)</code> where possible because the Item methods are able to handle a wider variety of commands appropriately. The Actions are best reserved for use in cases where the Item’s name is determined at runtime.</p>
|
||
|
||
<ul>
|
||
<li><code class="highlighter-rouge">Map<Item, State> storeStates(Item item1, Item item2, ... Item itemn)</code>: Returns a <code class="highlighter-rouge">Map<Item, State></code> with the current state of each Item. All members of Groups are put into the Map but not the Group’s state itself.</li>
|
||
<li><code class="highlighter-rouge">restoreStates(Map<Item, State> statesMap)</code>: Restores the items’ states from the map. If the saved state can be interpreted as a command (ON/OFF/etc.), a command is sent to the Item. Otherwise an update is sent to the Item.</li>
|
||
</ul>
|
||
|
||
<h3 id="audio-actions">Audio Actions</h3>
|
||
|
||
<ul>
|
||
<li><code class="highlighter-rouge">setMasterVolume(float volume)</code>: Sets the volume of the host machine (volume in range 0-1)</li>
|
||
<li><code class="highlighter-rouge">increaseMasterVolume(float percent)</code>: Increases the volume by the given percent</li>
|
||
<li><code class="highlighter-rouge">decreaseMasterVolume(float percent)</code>: Decreases the volume by the given percent</li>
|
||
<li><code class="highlighter-rouge">float getMasterVolume()</code>: Returns the current volume as a float between 0 and 1</li>
|
||
<li><code class="highlighter-rouge">playSound(String filename)</code>: Plays the given sound file. The file must be an mp3 or wav and located in <code class="highlighter-rouge">${openhab.home}/sounds</code></li>
|
||
<li><code class="highlighter-rouge">playStream(String url)</code>: Plays the audio stream at the given url</li>
|
||
<li><code class="highlighter-rouge">say(String text)</code>: Says the given text through Text-to-Speech</li>
|
||
<li><code class="highlighter-rouge">say(String text, String voice)</code>: Says the given text through the given voice (depends on the TTS engine and voices installed)</li>
|
||
<li><code class="highlighter-rouge"> say(String text, String voice, String device)</code>: Says the given text through the given voice to the given output device (Mac OSX only).</li>
|
||
</ul>
|
||
|
||
<p>To get a list of available voices use <code class="highlighter-rouge">say -v ?</code> and to get a list of devices uses <code class="highlighter-rouge">say -a ?</code>.</p>
|
||
|
||
<h3 id="logging-actions">Logging Actions</h3>
|
||
|
||
<ul>
|
||
<li><code class="highlighter-rouge">logDebug(String loggername, String logText)</code>: Logs logText on level DEBUG to openhab.log</li>
|
||
<li><code class="highlighter-rouge">logInfo(String loggername, String logText)</code>: Logs logText on level INFO to openhab.log</li>
|
||
<li><code class="highlighter-rouge">logWarn(String loggername, String logText)</code>: Logs logText on level WARN to openhab.log</li>
|
||
<li><code class="highlighter-rouge">logError(String loggername, String logText)</code>: Logs logText on level ERROR to openhab.log</li>
|
||
</ul>
|
||
|
||
<p><code class="highlighter-rouge">logText</code> can be a compete String, constructed through concatination, or through arguments.</p>
|
||
|
||
<ul>
|
||
<li><strong>Complete String Example:</strong> <code class="highlighter-rouge">logInfo("Garage", "This is a complete String")</code></li>
|
||
<li><strong>Concatination Example:</strong> <code class="highlighter-rouge">logDebug("Lighting", "This is a string concatination:" + Light.name)</code></li>
|
||
<li><strong>Arguments Example:</strong> <code class="highlighter-rouge">logWarn("Alarm", "The {} window has been open for {} hours!", Window.name, timeOpen)</code></li>
|
||
</ul>
|
||
|
||
<p>One can configure whether specific log entries are logged out and where they get logged to (e.g. to a separate file) by <a href="/v2.1/administration/logging.html">editing the logger configuration</a>.</p>
|
||
|
||
<h3 id="http-actions">HTTP Actions</h3>
|
||
|
||
<ul>
|
||
<li><code class="highlighter-rouge">sendHttpGetRequest(String url)</code>: Sends an GET-HTTP request and returns the result as a String</li>
|
||
<li><code class="highlighter-rouge">sendHttpPutRequest(String url)</code>: Sends a PUT-HTTP request and returns the result as a String</li>
|
||
<li><code class="highlighter-rouge">sendHttpPutRequest(String url, Sting contentType, String content)</code>: Sends a PUT-HTTP request with the given content and returns the result as a String</li>
|
||
<li><code class="highlighter-rouge">sendHttpPostRequest(String url)</code>: Sends a POST-HTTP request and returns the result as a String</li>
|
||
<li><code class="highlighter-rouge">sendHttpPostRequest(String url, String contentType, String content)</code>: Sends a POST-HTTP request with the given content and returns the result as a String</li>
|
||
<li><code class="highlighter-rouge">sendHttpDeleteRequest(String url)</code>: Sends a DELETE-HTTP request and returns the result as a String</li>
|
||
</ul>
|
||
|
||
<h3 id="timers">Timers</h3>
|
||
|
||
<p><code class="highlighter-rouge">createTimer(AbstractInstant instant, Procedure procedure)</code>: schedules a block of code to execute at a future time</p>
|
||
|
||
<ul>
|
||
<li><code class="highlighter-rouge">instant</code> is usually a <code class="highlighter-rouge">DateTime</code> calculated using the built in variable <code class="highlighter-rouge">now</code>.</li>
|
||
<li><code class="highlighter-rouge">procedure</code> is the block of code and is defined using lambda notation (i.e. square brackets)</li>
|
||
</ul>
|
||
|
||
<p>For example:</p>
|
||
|
||
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">var</span> <span class="n">Timer</span> <span class="n">myTimer</span> <span class="o">=</span> <span class="n">createTimer</span><span class="o">(</span><span class="n">now</span><span class="o">.</span><span class="na">plusMinutes</span><span class="o">(</span><span class="mi">5</span><span class="o">),</span> <span class="o">[|</span>
|
||
<span class="n">logInfo</span><span class="o">(</span><span class="s">"rules"</span><span class="o">,</span> <span class="s">"Timer activated"</span><span class="o">)</span>
|
||
<span class="o">])</span>
|
||
</code></pre></div></div>
|
||
|
||
<p>The Timer object supports the following methods:</p>
|
||
|
||
<ul>
|
||
<li><code class="highlighter-rouge">cancel</code>: prevents the scheduled timer from executing</li>
|
||
<li><code class="highlighter-rouge">isRunning</code>: returns true if the code is currently executing (i.e. the timer activated the code but it is not done running)</li>
|
||
<li><code class="highlighter-rouge">hasTerminated</code>: returns true if the code has run and completed</li>
|
||
<li><code class="highlighter-rouge">reschedule(AbstractInstant instant)</code>: reschedules the timer to execute at the new time. If the Timer has terminated this method does nothing.</li>
|
||
</ul>
|
||
|
||
<h2 id="installable-actions">Installable Actions</h2>
|
||
|
||
<table id="actions-select" class="striped">
|
||
<tbody>
|
||
<tr>
|
||
<td width="20%">
|
||
<p>
|
||
<input type="checkbox" class="filled-in" id="manual-checkbox" />
|
||
<label for="manual-checkbox"><img src="/v2.1/images/tag-install-manual.svg" /></label>
|
||
</p>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
Some openHAB 1 actions have not yet completed validation for inclusion in the distribution; however, they may indeed work properly under openHAB 2.
|
||
All openHAB 1 addons can be downloaded in a <a href="https://bintray.com/openhab/mvn/download_file?file_path=org%2Fopenhab%2Fdistro%2Fopenhab%2F1.9.0%2Fopenhab-1.9.0-addons.zip">zip file</a>.
|
||
We need your help testing them so that they may be easily installed in a future distribution.
|
||
Please see the <a href="/v2.1/developers/development/compatibilitylayer.html#how-to-use-openhab-1x-add-ons-that-are-not-part-of-the-distribution">compatibility layer documentation</a> and
|
||
also search the <a href="https://community.openhab.org">openHAB community forum</a> for the latest information and steps for manual installation.
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
<table id="actions-overview" class="bordered addon-table">
|
||
<thead>
|
||
<tr>
|
||
<th data-field="label" width="20%">Name</th>
|
||
<th data-field="description">Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
|
||
<tr class="install-manual since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/astro/readme.html">Astro</a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-manual.svg" />
|
||
</td>
|
||
<td><p>With the Astro actions, you can calculate sunrise and sunset DataTime values in rules.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-manual since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/ciscospark/readme.html">Cisco Spark</a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-manual.svg" />
|
||
</td>
|
||
<td><p>Cisco Spark can be used to message individuals are <em>rooms</em> when certain events take place in openHAB.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-manual since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/dscalarm/readme.html"><img class="logo" src="/v2.1/images/addons/dscalarm.png" title="DSC Alarm" alt="DSC Alarm" /></a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-manual.svg" />
|
||
</td>
|
||
<td><p>This bundle exposes openHAB rule extensions to be used with the DSC Alarm Binding (1.x binding). It allows the sending of DSC Alarm specific commands from within rules.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-auto since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/ecobee/readme.html"><img class="logo" src="/v2.1/images/addons/ecobee.png" title="Ecobee" alt="Ecobee" /></a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-auto.svg" />
|
||
</td>
|
||
<td><p>The Ecobee Action bundle provides actions such as setting and clearing program holds, sending a text message to the thermostat’s display, renaming a remote wireless sensor, and other functions that cannot be performed by setting object properties.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-manual since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/harmonyhub/readme.html">Logitech Harmony Hub</a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-manual.svg" />
|
||
</td>
|
||
<td><ul>
|
||
<li><code class="highlighter-rouge">harmonyPressButton(<device>, <command>)</code></li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-manual since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/homematic/readme.html"><img class="logo" src="/v2.1/images/addons/homematic.png" title="Homematic" alt="Homematic" /></a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-manual.svg" />
|
||
</td>
|
||
<td><p>The Homematic action lets you send messages to a Homematic remote control with a display, currently the HM-RC-19-B (Radio remote control 19 button).</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-auto since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/mail/readme.html">Mail</a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-auto.svg" />
|
||
</td>
|
||
<td><p>This add-on provides SMTP services so your rules and scripts can send e-mails. The <code class="highlighter-rouge">to</code> paremeter can contain a semicolon-separated list of email addresses.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-auto since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/mios/readme.html">MiOS</a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-auto.svg" />
|
||
</td>
|
||
<td><p>This bundle exposes openHAB Rule extensions to be used with the MiOS Binding (1.x).</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-auto since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/mqtt/readme.html"><img class="logo" src="/v2.1/images/addons/mqtt.png" title="MQTT" alt="MQTT" /></a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-auto.svg" />
|
||
</td>
|
||
<td><p>Publish a message to a topic on an MQTT broker.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-auto since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/nma/readme.html">NotifyMyAndroid</a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-auto.svg" />
|
||
</td>
|
||
<td><p>Sends push messages to your Android devices.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-manual since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/openwebif/readme.html">OpenWebIf</a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-manual.svg" />
|
||
</td>
|
||
<td><p>The OpenWebIf action allows you to send a message to enigma2-based Linux satellite receivers (Dreambox, VU+, Clarke-Tech, …) with the installed OpenWebIf plugin.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-auto since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/pebble/readme.html">Pebble</a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-auto.svg" />
|
||
</td>
|
||
<td><p>The Pebble action service allows you to send pins and notifications directly to your Pebble watch.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-auto since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/prowl/readme.html">Prowl</a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-auto.svg" />
|
||
</td>
|
||
<td><p>Prowl lets you use push notifications on iOS devices (please check openhab.cfg for required configuration settings):</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-auto since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/pushover/readme.html"><img class="logo" src="/v2.1/images/addons/pushover.png" title="Pushover" alt="Pushover" /></a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-auto.svg" />
|
||
</td>
|
||
<td><p>The Pushover action service allows you to notify mobile devices of a message using the Pushover API web service.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-auto since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/pushsafer/readme.html">Pushsafer</a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-auto.svg" />
|
||
</td>
|
||
<td><p>The Pushsafer action allows you to notify iOS, Android & Windows 10 Phone & Desktop devices of a message using the Pushsafer API web service.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-auto since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/satel/readme.html">Satel</a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-auto.svg" />
|
||
</td>
|
||
<td><p>The Satel Action bundle provides actions to read the event log of the connected alarm system, check current connection status and override configured user code.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-manual since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/squeezebox/readme.html"><img class="logo" src="/v2.1/images/addons/squeezebox.png" title="Squeezebox" alt="Squeezebox" /></a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-manual.svg" />
|
||
</td>
|
||
<td><p>Interact directly with your Squeezebox devices from within rules and scripts.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-auto since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/telegram/readme.html">Telegram</a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-auto.svg" />
|
||
</td>
|
||
<td><p>The Telegram Action service allows sending formatted messages to Telegram clients (<a href="https://telegram.org">https://telegram.org</a>), by using the Telegram Bot API.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-manual since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/tinkerforge/readme.html"><img class="logo" src="/v2.1/images/addons/tinkerforge.png" title="TinkerForge" alt="TinkerForge" /></a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-manual.svg" />
|
||
</td>
|
||
<td><p>The TinkerForge Action service provides direct interaction with some of the TinkerForge devices.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-auto since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/twitter/readme.html"><img class="logo" src="/v2.1/images/addons/twitter.png" title="Twitter" alt="Twitter" /></a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-auto.svg" />
|
||
</td>
|
||
<td><p>Twitter can be used to ‘tweet’ notifications when certain events take place in openHAB.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-manual since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/weather/readme.html">Weather</a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-manual.svg" />
|
||
</td>
|
||
<td><p>The Weather Action service provides meteorological information to your scripts and rules.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-auto since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/xbmc/readme.html"><img class="logo" src="/v2.1/images/addons/xbmc.png" title="XBMC" alt="XBMC" /></a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-auto.svg" />
|
||
</td>
|
||
<td><p>Sends notifications to the Kodi open source home theater software (formerly known as XBMC).</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-auto since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/xmpp/readme.html"><img class="logo" src="/v2.1/images/addons/xmpp.png" title="XMPP" alt="XMPP" /></a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-auto.svg" />
|
||
</td>
|
||
<td><p>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.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr class="install-manual since-1x">
|
||
<td>
|
||
<h4><a href="/v2.1/addons/actions/xpl/readme.html">xPL</a></h4>
|
||
<img src="/v2.1/images/tag-since-1x.svg" /> <img src="/v2.1/images/tag-install-manual.svg" />
|
||
</td>
|
||
<td><p>This add-on provides xPL message sending on the network.</p>
|
||
</td>
|
||
</tr>
|
||
|
||
</tbody>
|
||
</table>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<footer>
|
||
<div class="container">
|
||
<div class="row">
|
||
<div class="col s12 m7">
|
||
Copyright © 2017 by the <a href="https://github.com/openhab">openHAB Community</a> and the <a href="http://www.openhabfoundation.org/">openHAB Foundation e.V.</a>
|
||
</div>
|
||
<div class="col s12 m5">
|
||
<ul class="list-inline right-align">
|
||
<li><a href="/imprint.html">Imprint</a></li>
|
||
<li><a href="/privacy.html">Privacy Policy</a></li>
|
||
<li><a href="http://www.openhab.org">openHAB Website</a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
<script src="/v2.1/js/jquery.min.js"></script>
|
||
<script src="/v2.1/js/jquery.scrollme.min.js"></script>
|
||
<script src="/v2.1/js/jquery.sticky.js"></script>
|
||
<script src="/v2.1/js/materialize.min.js"></script>
|
||
<script src="/v2.1/js/init.js"></script>
|
||
|
||
<script>
|
||
$(document).ready(function () {
|
||
|
||
$('#oh2-checkbox').change(function () {
|
||
if (this.checked) $('.since-2x').show('slow');
|
||
else $('.source-oh2').hide('slow');
|
||
});
|
||
|
||
$('#oh1-checkbox').change(function () {
|
||
if (this.checked) $('.since-1x').show('slow');
|
||
else $('.source-oh1').hide('slow');
|
||
});
|
||
|
||
$('#legacy-checkbox').change(function () {
|
||
if (this.checked) $('.install-legacy').show('slow');
|
||
else $('.install-legacy').hide('slow');
|
||
});
|
||
|
||
$('#manual-checkbox').change(function () {
|
||
if (this.checked) $('.install-manual').show('slow');
|
||
else $('.install-manual').hide('slow');
|
||
});
|
||
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html>
|
||
|