1477 lines
52 KiB
HTML
1477 lines
52 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>The Console - openHAB 2 - Empowering the Smart Home</title>
|
|
|
|
<!-- CSS -->
|
|
<link type="text/css" rel="stylesheet" href="/v2.2/css/materialize.css" media="screen,projection" />
|
|
<link type="text/css" rel="stylesheet" href="/v2.2/css/pygments-jekyll-style.css" />
|
|
<link type="text/css" rel="stylesheet" href="/v2.2/css/styles.css" />
|
|
<link type="text/css" rel="stylesheet" href="/v2.2/css/openhab.css" />
|
|
<link type="text/css" rel="stylesheet" href="/v2.2/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="https://docs.openhab.org/administration/console.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.2/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.2/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.2/index.html">Home</a></li>
|
|
<li><a href="/tutorials/index.html">Tutorials</a></li>
|
|
<li><a href="/v2.2/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.2/introduction.html">Introduction</a></li>
|
|
<li><a href="/v2.2/concepts/index.html">Concepts</a>
|
|
<ul>
|
|
<li><a href="/v2.2/concepts/index.html">Overview</a></li>
|
|
<hr />
|
|
<li><a href="/v2.2/concepts/things.html">Things</a></li>
|
|
<li><a href="/v2.2/concepts/items.html">Items</a></li>
|
|
<li><a href="/v2.2/concepts/discovery.html">Inbox & Discovery</a></li>
|
|
<li><a href="/v2.2/concepts/audio.html">Audio & Voice</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="/v2.2/installation/index.html">Installation</a>
|
|
<ul>
|
|
<li><a href="/v2.2/installation/index.html">Overview</a></li>
|
|
<hr />
|
|
<li><a href="/v2.2/installation/linux.html">Linux</a></li>
|
|
<li><a href="/v2.2/installation/windows.html">Windows</a></li>
|
|
<li><a href="/v2.2/installation/macosx.html">Mac OS X</a></li>
|
|
<hr />
|
|
<li><a href="/v2.2/installation/openhabian.html">openHABian</a></li>
|
|
<li><a href="/v2.2/installation/docker.html">Docker</a></li>
|
|
<hr />
|
|
<li><a href="/v2.2/installation/rasppi.html">Raspberry Pi</a></li>
|
|
<li><a href="/v2.2/installation/pine.html">Pine A64</a></li>
|
|
<li><a href="/v2.2/installation/synology.html">Synology DiskStation</a></li>
|
|
<li><a href="/v2.2/installation/qnap.html">QNAP NAS</a></li>
|
|
<hr />
|
|
<li><a href="/v2.2/installation/security.html">Security & Remote Access</a></li>
|
|
<li><a href="http://www.myopenhab.org">myopenHAB</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="/v2.2/configuration/index.html">Configuration</a>
|
|
<ul>
|
|
<li><a href="/v2.2/configuration/index.html">Overview</a></li>
|
|
<hr />
|
|
<li><a href="/v2.2/configuration/things.html">Things</a></li>
|
|
<li><a href="/v2.2/configuration/items.html">Items</a></li>
|
|
<li><a href="/v2.2/configuration/sitemaps.html">Sitemaps</a></li>
|
|
<li><a href="/v2.2/configuration/transform.html">Transformations</a></li>
|
|
<li><a href="/v2.2/configuration/persistence.html">Persistence</a></li>
|
|
<li><a href="/v2.2/configuration/rules-dsl.html">Rules</a></li>
|
|
<li><a href="/v2.2/configuration/jsr223.html">JSR223 Scripting</a>
|
|
<ul>
|
|
<li><a href="/v2.2/configuration/jsr223.html">Overview</a>
|
|
<hr />
|
|
<li><a href="/v2.2/configuration/jsr223-js.html">Javascript</a></li>
|
|
<li><a href="/v2.2/configuration/jsr223-jython.html">Jython</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="/v2.2/configuration/services.html">Services</a></li>
|
|
<hr />
|
|
<li><a href="/v2.2/configuration/packages.html">Initial Setup Packages</a></li>
|
|
<li><a href="/v2.2/configuration/homebuilder.html">Home Builder</a></li>
|
|
<li><a href="/v2.2/configuration/paperui.html">Paper UI</a></li>
|
|
<li><a href="/v2.2/configuration/habmin.html">HABmin</a></li>
|
|
<li><a href="/v2.2/configuration/habpanel.html">HABPanel</a></li>
|
|
<li><a href="/v2.2/configuration/rules-ng.html">Rules (Experimental)</a></li>
|
|
<li><a href="/v2.2/configuration/editors.html">Editors</a></li>
|
|
<hr />
|
|
<li><a href="/v2.2/configuration/multimedia.html">Audio & Voice</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="/v2.2/addons/index.html">Add-ons</a>
|
|
<ul>
|
|
<li><a href="/v2.2/addons/index.html">Overview</a></li>
|
|
<hr />
|
|
<li><a href="/v2.2/addons/bindings.html">Bindings</a>
|
|
<ul>
|
|
<li><a href="/v2.2/addons/bindings.html">Overview</a></li>
|
|
<hr />
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/airquality/readme.html">Air Quality</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/alarmdecoder1/readme.html">Alarm Decoder</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/allplay/readme.html">AllPlay</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/amazondashbutton/readme.html">Amazon Dash Button</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/anel1/readme.html">Anel NET-PwrCtrl</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/astro/readme.html">Astro</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/atlona/readme.html">Atlona</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/autelis/readme.html">Autelis Pool Control</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/avmfritz/readme.html">AVM FRITZ!</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/bigassfan/readme.html">BigAssFan</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/boschindego/readme.html">Bosch Indego</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/bticino1/readme.html">Bticino</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/caldav-command1/readme.html">CalDAV Command</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/caldav-personal1/readme.html">CalDAV Personal</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/chromecast/readme.html">Chromecast</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/cm11a/readme.html">Cm11a (X10 controller)</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/comfoair1/readme.html">ComfoAir</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/coolmasternet/readme.html">CoolMasterNet</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/denon1/readme.html">Denon</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/digitalstrom/readme.html">digitalSTROM</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/dlinksmarthome/readme.html">D-Link Smart Home</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/dmx/readme.html">DMX</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/dscalarm/readme.html">DSC Alarm</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/dsmr1/readme.html">DSMR</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/ebus1/readme.html">eBUS</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/ecobee1/readme.html">Ecobee</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/ecotouch1/readme.html">EcoTouch</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/ekey1/readme.html">ekey</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/energenie1/readme.html">Energenie</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/enocean1/readme.html">EnOcean</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/enphaseenergy1/readme.html">Enphase Energy</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/epsonprojector1/readme.html">Epson Projector</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/exec/readme.html">Exec</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/expire1/readme.html">Expire</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/fatekplc1/readme.html">Fatek PLC</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/feed/readme.html">Feed</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/feican/readme.html">Feican</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/folding/readme.html">Folding@home</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/freebox/readme.html">Freebox</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/freeswitch1/readme.html">FreeSWITCH</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/fritzbox1/readme.html">Fritz!Box</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/fritzboxtr0641/readme.html">Fritzbox (using TR064 protocol)</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/fs201/readme.html">FS20</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/fsinternetradio/readme.html">FS Internet Radio</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/garadget1/readme.html">Garadget</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/gardena/readme.html">Gardena</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/gc100ir1/readme.html">Global Cache IR</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/globalcache/readme.html">GlobalCache</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/harmonyhub/readme.html">Logitech Harmony Hub</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/hdanywhere/readme.html">HDanywhere</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/hdpowerview/readme.html">Hunter Douglas PowerView</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/heatmiser1/readme.html">Heatmiser</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/homematic/readme.html">Homematic</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/http1/readme.html">HTTP</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/hue/readme.html">Philips Hue</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/icloud/readme.html">iCloud</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/ihc1/readme.html">IHC / ELKO</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/insteonplm1/readme.html">Insteon PLM</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/intertechno1/readme.html">Intertechno</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/ipp/readme.html">IPP</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/ipx8001/readme.html">IPX800</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/irtrans1/readme.html">IRTrans</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/jeelink/readme.html">Jeelink</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/jointspace1/readme.html">jointSPACE</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/keba/readme.html">Keba</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/knx1/readme.html">KNX</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/kodi/readme.html">Kodi</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/kostalinverter/readme.html">Kostal Inverter</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/koubachi1/readme.html">Koubachi</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/lcn1/readme.html">LCN</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/lgtv1/readme.html">LG TV</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/lgtvserial/readme.html">LG TV control using serial protocol</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/lgwebos/readme.html">LG webOS</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/lifx/readme.html">LIFX</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/lirc/readme.html">LIRC</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/loxone/readme.html">Loxone</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/lutron/readme.html">Lutron</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/max/readme.html">MAX!</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/maxcul1/readme.html">MAX!CUL</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/meteostick/readme.html">Meteostick</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/miele/readme.html">Miele@home</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/mihome/readme.html">Xiaomi Mi Smart Home</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/milight/readme.html">Milight/Easybulb/Limitless</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/minecraft/readme.html">Minecraft</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/mios1/readme.html">MiOS Bridge</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/mochadx101/readme.html">Mochad X10</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/modbus1/readme.html">Modbus</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/mqtt1/readme.html">MQTT</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/mqttitude1/readme.html">OwnTracks (formerly MQTTitude)</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/myq1/readme.html">Chamberlain MyQ</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/neohub1/readme.html">NeoHub</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/nest/readme.html">Nest</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/netatmo/readme.html">Netatmo</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/network/readme.html">Network</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/networkupstools1/readme.html">Network UPS Tools</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/nibeheatpump1/readme.html">Nibe Heatpump</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/nikobus1/readme.html">Nikobus</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/nikohomecontrol/readme.html">Niko Home Control</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/novelanheatpump1/readme.html">Novelan/Luxtronic Heat Pump</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/ntp/readme.html">NTP</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/oceanic/readme.html">Oceanic</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/onebusaway/readme.html">OneBusAway</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/onewire1/readme.html">OneWire</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/onkyo/readme.html">Onkyo</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/openenergymonitor1/readme.html">Open Energy Monitor</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/opensprinkler/readme.html">OpenSprinkler</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/orvibo/readme.html">Orvibo</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/owserver1/readme.html">OWServer</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/panasonictv1/readme.html">Panasonic TV</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/piface1/readme.html">Piface</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/pioneeravr/readme.html">PioneerAVR Configuration</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/plex1/readme.html">Plex</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/plugwise/readme.html">Plugwise</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/powermax1/readme.html">Visonic Powermax</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/pulseaudio/readme.html">Pulseaudio</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/regoheatpump/readme.html">RegoHeatPump</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/rfxcom/readme.html">RFXCOM</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/rme/readme.html">RME</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/rotelra1x/readme.html">Rotel Amplifier</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/russound/readme.html">Russound</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/rwesmarthome1/readme.html">RWE SmartHome</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/samsungac1/readme.html">Samsung Air Conditioner</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/samsungtv/readme.html">Samsung TV</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/sapp1/readme.html">Picnet Sapp</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/satel1/readme.html">Satel Integra Alarm System</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/sensebox/readme.html">senseBox</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/serial1/readme.html">Serial</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/serialbutton/readme.html">Serial Button</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/silvercrestwifisocket/readme.html">Silvercrest Wifi Plug</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/sleepiq/readme.html">SleepIQ</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/smaenergymeter/readme.html">SMA Energy Meter</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/snmp1/readme.html">SNMP</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/sonance1/readme.html">Sonance</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/sonos/readme.html">Sonos</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/souliss1/readme.html">Souliss</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/squeezebox/readme.html">Logitech Squeezebox</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/swegonventilation1/readme.html">Swegon Ventilation</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/synopanalyzer/readme.html">Synop Analyzer</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/systeminfo/readme.html">Systeminfo</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/tankerkoenig/readme.html">Tankerkönig</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/tcp1/readme.html">TCP & UDP</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/tellstick/readme.html">Tellstick</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/tesla/readme.html">Tesla</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/tinkerforge1/readme.html">TinkerForge</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/toon/readme.html">Toon</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/tplinksmarthome/readme.html">TPLinkSmartHome</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/tradfri/readme.html">TRÅDFRI</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/upb1/readme.html">UPB</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/urtsi/readme.html">Somfy URTSI II</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/vitotronic/readme.html">Vitotronic</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/weather1/readme.html">Weather</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/weatherunderground/readme.html">WeatherUnderground</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/wemo/readme.html">Belkin Wemo</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/wifiled/readme.html">WiFi LED</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/windcentrale/readme.html">Windcentrale</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/wol1/readme.html">Wake-on-LAN</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/xbmc1/readme.html">XBMC binding (for KODI) (1.x)</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/yahooweather/readme.html">YahooWeather</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/yamahareceiver/readme.html">Yamahareceiver</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/zigbee/readme.html">ZigBee</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/zoneminder/readme.html">Zoneminder</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/zwave/readme.html">ZWave</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/bindings/zway/readme.html">Z-Way</a></li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
<li><a href="/v2.2/addons/uis.html">User Interfaces</a>
|
|
<ul>
|
|
<li><a href="/v2.2/addons/uis.html">Overview</a></li>
|
|
<hr />
|
|
|
|
<li><a href="/v2.2/addons/uis/basic/readme.html">Basic UI</a></li>
|
|
|
|
<li><a href="/v2.2/addons/uis/classic/readme.html">Classic UI</a></li>
|
|
|
|
<li><a href="/v2.2/addons/uis/habmin/readme.html">HABmin</a></li>
|
|
|
|
<li><a href="/v2.2/addons/uis/habpanel/doc/habpanel.html"></a></li>
|
|
|
|
<li><a href="/v2.2/addons/uis/habpanel/readme.html">HABPanel</a></li>
|
|
|
|
<li><a href="/v2.2/addons/uis/paper/readme.html">Paper UI</a></li>
|
|
|
|
<hr />
|
|
<li><a href="/v2.2/addons/uis/apps/android.html">Android App</a></li>
|
|
<li><a href="/v2.2/addons/uis/apps/ios.html">iOS App</a></li>
|
|
<li><a href="/v2.2/addons/uis/apps/windows.html">Windows 10 App</a></li>
|
|
<hr />
|
|
<li><a href="/v2.2/addons/iconsets/classic/readme.html">Iconset (classic)</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="/v2.2/addons/persistence.html">Persistence</a>
|
|
<ul>
|
|
<li><a href="/v2.2/addons/persistence.html">Overview</a></li>
|
|
<hr />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/persistence/influxdb/readme.html">InfluxDB (0.9 and newer)</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/persistence/jdbc/readme.html">JDBC</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/persistence/jpa/readme.html">Java Persistence API (JPA)</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/persistence/mapdb/readme.html">mapdb</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/persistence/mqtt/readme.html">MQTT</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/persistence/mysql/readme.html">MySQL</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/persistence/rrd4j/readme.html">rrd4j</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
<li><a href="/v2.2/addons/actions.html">Actions</a>
|
|
<ul>
|
|
<li><a href="/v2.2/addons/actions.html">Overview</a></li>
|
|
<hr />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/actions/ecobee/readme.html">Ecobee</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/actions/mail/readme.html">Mail</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/actions/mios/readme.html">MiOS</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/actions/mqtt/readme.html">MQTT</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/actions/nma/readme.html">NotifyMyAndroid</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/actions/pebble/readme.html">Pebble</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/actions/prowl/readme.html">Prowl</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/actions/pushbullet/readme.html">Pushbullet</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/actions/pushover/readme.html">Pushover</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/actions/pushsafer/readme.html">Pushsafer</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/actions/satel/readme.html">Satel</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/actions/telegram/readme.html">Telegram</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/actions/twitter/readme.html">Twitter</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/actions/xbmc/readme.html">XBMC</a></li>
|
|
|
|
|
|
|
|
<li><a href="/v2.2/addons/actions/xmpp/readme.html">XMPP</a></li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
<li><a href="/v2.2/addons/transformations.html">Transformations</a>
|
|
<ul>
|
|
<li><a href="/v2.2/addons/transformations.html">Overview</a></li>
|
|
<hr />
|
|
|
|
<li><a href="/v2.2/addons/transformations/exec/readme.html">Exec</a></li>
|
|
|
|
<li><a href="/v2.2/addons/transformations/javascript/readme.html">JavaScript</a></li>
|
|
|
|
<li><a href="/v2.2/addons/transformations/jsonpath/readme.html">JsonPath</a></li>
|
|
|
|
<li><a href="/v2.2/addons/transformations/map/readme.html">Map</a></li>
|
|
|
|
<li><a href="/v2.2/addons/transformations/regex/readme.html">RegEx</a></li>
|
|
|
|
<li><a href="/v2.2/addons/transformations/scale/readme.html">Scale</a></li>
|
|
|
|
<li><a href="/v2.2/addons/transformations/xpath/readme.html">XPath</a></li>
|
|
|
|
<li><a href="/v2.2/addons/transformations/xslt/readme.html">XSLT</a></li>
|
|
|
|
</ul>
|
|
</li>
|
|
<li><a href="/v2.2/addons/voices.html">Voice Services</a>
|
|
<ul>
|
|
<li><a href="/v2.2/addons/voices.html">Overview</a></li>
|
|
<hr />
|
|
|
|
<li><a href="/v2.2/addons/voices/mactts/readme.html">MacOS Text-to-Speech</a></li>
|
|
|
|
<li><a href="/v2.2/addons/voices/marytts/readme.html">Mary Text-to-Speech</a></li>
|
|
|
|
<li><a href="/v2.2/addons/voices/voicerss/readme.html">VoiceRSS Text-to-Speech</a></li>
|
|
|
|
</ul>
|
|
</li>
|
|
<hr />
|
|
<li><a href="/v2.2/addons/io.html">3rd Party Integration</a>
|
|
<ul>
|
|
<li><a href="/v2.2/addons/io.html">Overview</a></li>
|
|
<hr />
|
|
|
|
<li><a href="/v2.2/addons/ios/alexa-skill/readme.html">Amazon Alexa Skill</a></li>
|
|
|
|
<li><a href="/v2.2/addons/ios/dropbox/readme.html">Dropbox Synchronization</a></li>
|
|
|
|
<li><a href="/v2.2/addons/ios/gcal/readme.html">Google Calendar Scheduler</a></li>
|
|
|
|
<li><a href="/v2.2/addons/ios/homekit/readme.html">HomeKit Add-on</a></li>
|
|
|
|
<li><a href="/v2.2/addons/ios/hueemulation/readme.html">openHAB Hue Emulation</a></li>
|
|
|
|
<li><a href="/v2.2/addons/ios/imperihome/readme.html">ImperiHome integration service</a></li>
|
|
|
|
<li><a href="/v2.2/addons/ios/mycroft-skill/readme.html">Mycroft AI Skill</a></li>
|
|
|
|
<li><a href="/v2.2/addons/ios/openhabcloud/readme.html">openHAB Cloud Connector</a></li>
|
|
|
|
<hr />
|
|
<li><a href="/v2.2/configuration/restdocs.html">REST API</a></li>
|
|
<li><a href="/v2.2/configuration/eclipseiotmarket.html">Eclipse IoT Marketplace</a></li>
|
|
<li><a href="http://www.myopenhab.org/" target="_blank">IFTTT</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="/v2.2/administration/index.html">Advanced Functionality</a>
|
|
<ul>
|
|
<li><a href="/v2.2/administration/index.html">Overview</a></li>
|
|
<hr />
|
|
<li><a href="/v2.2/administration/console.html">Console</a></li>
|
|
<li><a href="/v2.2/administration/runtime.html">Runtime Commands</a></li>
|
|
<li><a href="/v2.2/administration/bundles.html">Bundle Management</a></li>
|
|
<li><a href="/v2.2/administration/logging.html">Logging</a></li>
|
|
<hr />
|
|
<li><a href="/v2.2/administration/jsondb.html">JsonDB Storage</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="/v2.2/appendix/help.html">Community Guidance</a>
|
|
<ul>
|
|
<li><a href="/v2.2/appendix/help.html">Finding Help & FAQs</a></li>
|
|
<li><a href="/v2.2/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.2/../administration/console.html">latest version</a></li>
|
|
<li><a href="/v2.2/administration/console.html">v2.2<i class="tiny material-icons right">lens</i></a></li>
|
|
<li><a href="/v2.2/../v2.1/administration/console.html">v2.1</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="the-console">The Console</h1>
|
|
|
|
<p>The console offers the option to:</p>
|
|
|
|
<ul>
|
|
<li>Monitor the <a href="logging.html#karaf-console">log</a> in realtime</li>
|
|
<li>Manage <a href="bundles.html">bundles</a></li>
|
|
<li>Execute <a href="runtime.html">runtime commands</a></li>
|
|
</ul>
|
|
|
|
<h2 id="accessing-the-console">Accessing the Console</h2>
|
|
|
|
<p>The method to access the console depends on how openHAB was started.</p>
|
|
|
|
<ul>
|
|
<li>When started in interactive mode using the provided command line scripts (e.g. <code class="highlighter-rouge">start.sh</code> or <code class="highlighter-rouge">start.bat</code>), openHAB naturally transitions directly to the console prompt.</li>
|
|
<li>When started as a service (i.e. when openHAB is running as a background process), access to the console is given by running the <code class="highlighter-rouge">$OPENHAB_RUNTIME/bin/client</code> (<code class="highlighter-rouge">client.bat</code> for Windows) script or by <a href="#connecting-via-ssh">connecting via SSH</a>.
|
|
Linux package based installations can also use the command <code class="highlighter-rouge">openhab-cli console</code>.</li>
|
|
</ul>
|
|
|
|
<p>The default username/password is <strong>openhab:habopen</strong>, so enter <code class="highlighter-rouge">habopen</code> at the password prompt.</p>
|
|
|
|
<h3 id="connecting-via-ssh">Connecting via SSH</h3>
|
|
|
|
<p>The console can also be reached via secure shell connection (<a href="https://en.wikipedia.org/wiki/Secure_Shell">SSH</a>).</p>
|
|
|
|
<p>To reach the console using SSH, use the following command to connect to the localhost interface on TCP port 8101:</p>
|
|
|
|
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code>ssh <span class="nt">-p</span> 8101 openhab@localhost
|
|
</code></pre></div></div>
|
|
|
|
<p><em>Note:</em> By default, connection is only allowed from localhost, i.e. only from the machine running openHAB.
|
|
Connections are intentionally not allowed from remote hosts due to security concerns.
|
|
To change this, see <a href="#bind-console-to-all-interfaces">Bind Console to All Interfaces</a>.</p>
|
|
|
|
<p>A security warning is expected upon the first connection:</p>
|
|
|
|
<div class="language-text highlighter-rouge"><div class="highlight"><pre class="highlight"><code>The authenticity of host '[localhost]:8101 ([127.0.0.1]:8101)' can't be established.
|
|
RSA key fingerprint is SHA256:XjQxBPit+K5m3HuSsEUI/842NTCxLTu3EMGGBuQKNVg.
|
|
Are you sure you want to continue connecting (yes/no)?
|
|
</code></pre></div></div>
|
|
|
|
<p>Enter <code class="highlighter-rouge">yes</code> to proceed.</p>
|
|
|
|
<div class="language-text highlighter-rouge"><div class="highlight"><pre class="highlight"><code>Warning: Permanently added '[localhost]:8101' (RSA) to the list of known hosts.
|
|
Password authentication
|
|
Password:
|
|
</code></pre></div></div>
|
|
|
|
<p>The default username/password is <strong>openhab:habopen</strong>, so enter <code class="highlighter-rouge">habopen</code> at the password prompt.</p>
|
|
|
|
<p>The first successful connection triggers generation of the Karaf remote console key and will take a few seconds longer than subsequent attempts.</p>
|
|
|
|
<p><em>Note:</em> On slower systems, such as Raspberry Pi or Pine64, this first SSH connection may even time out.
|
|
If this happens, simply try connecting again until successful.</p>
|
|
|
|
<h2 id="using-the-console">Using the Console</h2>
|
|
|
|
<p>After successful connection and authentication, the console will appear:</p>
|
|
|
|
<div class="language-text highlighter-rouge"><div class="highlight"><pre class="highlight"><code> __ _____ ____
|
|
____ ____ ___ ____ / / / / | / __ )
|
|
/ __ \/ __ \/ _ \/ __ \/ /_/ / /| | / __ |
|
|
/ /_/ / /_/ / __/ / / / __ / ___ |/ /_/ /
|
|
\____/ .___/\___/_/ /_/_/ /_/_/ |_/_____/
|
|
/_/ 2.2.0
|
|
Release Build
|
|
|
|
Hit '<tab>' for a list of available commands
|
|
and '[cmd] --help' for help on a specific command.
|
|
Hit '<ctrl-d>' or type 'system:shutdown' or 'logout' to shutdown openHAB.
|
|
|
|
openhab>
|
|
</code></pre></div></div>
|
|
|
|
<p>The command <code class="highlighter-rouge">help</code> is listing all available commands or describes a specific subsystem/command:</p>
|
|
|
|
<div class="language-text highlighter-rouge"><div class="highlight"><pre class="highlight"><code>openhab> help
|
|
...
|
|
openhab> help bundle
|
|
...
|
|
openhab> help bundle:stop
|
|
...
|
|
</code></pre></div></div>
|
|
|
|
<p>The console also supports auto-completion during input.
|
|
Auto-completion proposes possible commands based on the current input and is triggered by a <TAB> press on your keyboard.
|
|
So for example entering “<em>bund</em>” and pressing the <TAB> key will first extend to the only viable candidate “bundle”, a subsequent <TAB> press will result in:</p>
|
|
|
|
<div class="language-text highlighter-rouge"><div class="highlight"><pre class="highlight"><code>openhab> bundle
|
|
bundle bundle:capabilities bundle:classes bundle:diag bundle:dynamic-import
|
|
bundle:find-class bundle:headers bundle:id bundle:info bundle:install
|
|
bundle:list bundle:load-test bundle:refresh bundle:requirements bundle:resolve
|
|
bundle:restart bundle:services bundle:start bundle:start-level bundle:stop
|
|
bundle:tree-show bundle:uninstall bundle:update bundle:watch
|
|
</code></pre></div></div>
|
|
|
|
<p>Another useful feature is the combination of the <code class="highlighter-rouge">|</code> (pipe) and <code class="highlighter-rouge">grep</code> functionality, which can be used to filter output:</p>
|
|
|
|
<div class="language-text highlighter-rouge"><div class="highlight"><pre class="highlight"><code>openhab> bundle:list | grep openHAB
|
|
164 | Active | 90 | 2.0.0.201607210102 | openHAB Core
|
|
165 | Active | 80 | 2.0.0.201607210102 | openHAB Karaf Integration
|
|
195 | Active | 80 | 2.0.0.201607210102 | openHAB 1.x Compatibility Layer
|
|
196 | Active | 80 | 2.0.0.201607210102 | openHAB REST Documentation
|
|
</code></pre></div></div>
|
|
|
|
<p>The session is ended by using the logout command:</p>
|
|
|
|
<div class="language-text highlighter-rouge"><div class="highlight"><pre class="highlight"><code>openhab> logout
|
|
</code></pre></div></div>
|
|
|
|
<p>Learn about all available commands by using the initially introduced <code class="highlighter-rouge">help</code> command.</p>
|
|
|
|
<h2 id="modifying-the-console-settings">Modifying the Console Settings</h2>
|
|
|
|
<p>Changing the console password, interface, and port is described here.</p>
|
|
|
|
<h3 id="console-settings-files-and-directories">Console Settings Files and Directories</h3>
|
|
|
|
<p>The pertinent files controlling console settings are stored under <code class="highlighter-rouge">$OPENHAB_USERDATA/etc/</code>:</p>
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>File</th>
|
|
<th>Purpose</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">org.apache.karaf.shell.cfg</code></td>
|
|
<td>Controls most console settings</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code class="highlighter-rouge">users.properties</code></td>
|
|
<td>Stores console password</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<p>The exact locations of these files will vary based on your platform and installation method, e.g. <code class="highlighter-rouge">/var/lib/openhab2/etc/</code> or <code class="highlighter-rouge">openhab2/userdata/etc/</code>.</p>
|
|
|
|
<p>Be aware that the these files may get overwritten when upgrading openHAB.
|
|
To add custom parameters or overwrite the default values, you can change the configuration file <code class="highlighter-rouge">runtime.cfg</code> which can be found in the <code class="highlighter-rouge">$OPENHAB_CONF/services</code> directory, e.g. <code class="highlighter-rouge">/etc/openhab2/services/runtime.cfg</code>.</p>
|
|
|
|
<h3 id="changing-the-password">Changing the Password</h3>
|
|
|
|
<p>The password is stored in the file <code class="highlighter-rouge">users.properties</code>, located in the <code class="highlighter-rouge">etc</code> directory as <a href="#console-settings-files-and-directories">mentioned above</a>.
|
|
By default, the line with the password contains the text <code class="highlighter-rouge">openhab = </code>, followed by the current password (e.g. <code class="highlighter-rouge">habopen</code>) or a password hash (e.g. <code class="highlighter-rouge">{CRYPT}4AE1A0FD...{CRYPT}</code>).</p>
|
|
|
|
<p>To change the authentication password edit the file manually, replacing the password or password hash (including <code class="highlighter-rouge">{CRYPT}</code>) with your new password in clear text.
|
|
Alternately, run the following Linux shell command, which will perform the replacement for you.
|
|
Substitute <code class="highlighter-rouge">securePassword</code> with your desired password.</p>
|
|
|
|
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">sudo </span>sed <span class="nt">-i</span> <span class="nt">-e</span> <span class="s2">"s/openhab = .*,/openhab = securePassword,/g"</span> /var/lib/openhab2/etc/users.properties
|
|
</code></pre></div></div>
|
|
|
|
<p>Depending on your system, you may have to <a href="#console-settings-files-and-directories">change the directory</a> at the end of the command.
|
|
Please restart openHAB for the changes to take effect. The clear text password will be replaced by a unique cryptographic password hash.</p>
|
|
|
|
<h3 id="bind-console-to-all-interfaces">Bind Console to All Interfaces</h3>
|
|
|
|
<p>The network interface configuration is defined in the file <code class="highlighter-rouge">org.apache.karaf.shell.cfg</code>, located in the <code class="highlighter-rouge">etc</code> directory as <a href="#console-settings-files-and-directories">mentioned above</a>.
|
|
As this file may get overwritten when upgrading openHAB, you can change this parameter in the <code class="highlighter-rouge">runtime.cfg</code> file which can be found in the <code class="highlighter-rouge">$OPENHAB_CONF/services</code> directory, e.g. <code class="highlighter-rouge">/etc/openhab2/services/runtime.cfg</code>.</p>
|
|
|
|
<p>The <code class="highlighter-rouge">sshHost</code> entry controls the interface address to bind to.
|
|
<code class="highlighter-rouge">sshHost = 127.0.0.1</code> (localhost) is the default due to obvious security reasons.
|
|
If you are on a local network or you are fully aware of all risks of exposing your system to the public, you can change the bind address.
|
|
Replace the <code class="highlighter-rouge">sshHost</code> IP <code class="highlighter-rouge">127.0.0.1</code> by <code class="highlighter-rouge">0.0.0.0</code> to bind to all available network interfaces.
|
|
Please be aware, that the console will now be accessible from all devices in your subnet and is only secured by the password defined in <code class="highlighter-rouge">users.properties</code> (same path).
|
|
You should thereby <a href="#changing-the-password">change the password</a>.
|
|
Depending on your network configuration the console may also be exposed to the public internet, so check your routing and firewall configuration.</p>
|
|
|
|
<p>To enable binding to all interfaces, uncomment the line</p>
|
|
|
|
<p><code class="highlighter-rouge">#org.apache.karaf.shell:sshHost = 0.0.0.0</code></p>
|
|
|
|
<p>in <code class="highlighter-rouge">services/runtime.cfg</code>.</p>
|
|
|
|
<h3 id="change-the-port-number">Change the Port Number</h3>
|
|
|
|
<p>The SSH port configuration is done through the file <code class="highlighter-rouge">org.apache.karaf.shell.cfg</code>, located in the <code class="highlighter-rouge">etc</code> directory as <a href="#console-settings-files-and-directories">mentioned above</a>.
|
|
The <code class="highlighter-rouge">sshPort</code> entry controls the port number.
|
|
<code class="highlighter-rouge">sshPort = 8101</code> is the default, but can be changed to any available port per your choosing.</p>
|
|
|
|
<p>Alternately, run the following Linux shell command, which will perform the replacement for you.
|
|
Substitute <code class="highlighter-rouge">1234</code> with your desired port number.
|
|
Depending on your system, you may have to substitute <a href="#console-settings-files-and-directories">the directory</a> at the end of the command.</p>
|
|
|
|
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">sudo </span>sed <span class="nt">-i</span> <span class="nt">-e</span> <span class="s2">"s/sshPort = .*/sshPort = 1234/g"</span> /var/lib/openhab2/etc/org.apache.karaf.shell.cfg
|
|
</code></pre></div></div>
|
|
|
|
<hr />
|
|
|
|
<p>Please check the <a href="http://karaf.apache.org/manual/latest/">Apache Karaf reference</a> for more details.</p>
|
|
|
|
</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>
|
|
<li><a href=# onclick="printPage()">Print This Page</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<script src="/v2.2/js/jquery.min.js"></script>
|
|
<script src="/v2.2/js/jquery.scrollme.min.js"></script>
|
|
<script src="/v2.2/js/jquery.sticky.js"></script>
|
|
<script src="/v2.2/js/materialize.min.js"></script>
|
|
<script src="/v2.2/js/init.js"></script>
|
|
<script src="/v2.2/js/functions.js"></script>
|
|
</body>
|
|
</html>
|
|
|