openhab-docs/_addons_uis/habpanel
Yannick Schaus c0eef8b525
Partial merge final -> final-stable (#1569)
This performs a selective merge of the current docs into the "stable" branch
that will hold the default docs for the 3.0.2 release (until they're
replaced with the current ones once 3.1 is released).

* Backport bindings docs that looked applicable to 3.0
* Revert UI components changes not in stable

Signed-off-by: Yannick Schaus <github@schaus.net>

Co-authored-by: openHAB Build Server <infrastructure@openhab.org>
Co-authored-by: stefan-hoehn <stefan.hoehn@aoe.com>
Co-authored-by: jimtng <2554958+jimtng@users.noreply.github.com>
Co-authored-by: Matt <lawrence.matt@gmail.com>
Co-authored-by: Jerome Luckenbach <github@luckenba.ch>
Co-authored-by: Kai Kreuzer <kai@openhab.org>
Co-authored-by: Felix Schneider <45742226+Trysupe@users.noreply.github.com>
Co-authored-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
Co-authored-by: J-N-K <J-N-K@users.noreply.github.com>
Co-authored-by: Eiko Wagenknecht <eiko.wagenknecht@web.de>
Co-authored-by: Alexander Behring <github.com@alexander-behring.eu>
Co-authored-by: Matthew Skinner <matt@pcmus.com>
Co-authored-by: Christoph Weitkamp <github@christophweitkamp.de>
Co-authored-by: Patrick Fink <mail@pfink.de>
Co-authored-by: Gifford47 <49484063+Gifford47@users.noreply.github.com>
Co-authored-by: Seganku <seganku@users.noreply.github.com>
Co-authored-by: digitlength <62958838+digitlength@users.noreply.github.com>
Co-authored-by: Ross Kennedy <rossko@culzean.clara.co.uk>
Co-authored-by: Fabian Wolter <github@fabian-wolter.de>
Co-authored-by: Arjan Mels <43108771+arjanmels@users.noreply.github.com>
Co-authored-by: Jonathan Gilbert <github.10.jgilbert@xoxy.net>
Co-authored-by: Richard Koshak <rkoshak@users.noreply.github.com>
Co-authored-by: Wolfgang Schueschen <76775650+WolfgangSn@users.noreply.github.com>
Co-authored-by: Gareth Western <gareth@garethwestern.com>
Co-authored-by: Bob A <bobadair@users.noreply.github.com>
Co-authored-by: Sami Salonen <ssalonen@gmail.com>
Co-authored-by: Peter Schraffl <p.schraffl@gmx.at>
Co-authored-by: Georgios Moutsos <50378548+jossuar@users.noreply.github.com>
Co-authored-by: Markus Storm <markus.storm@gmx.net>
Co-authored-by: JensHoRi <47488279+JensHoRi@users.noreply.github.com>
Co-authored-by: Felix <24674809+fex01@users.noreply.github.com>
Co-authored-by: Koen Schockaert <54985218+QbusKoen@users.noreply.github.com>
Co-authored-by: Ethan Dye <mrtops03@gmail.com>
Co-authored-by: Senne Croughs <38940112+sencro@users.noreply.github.com>
Co-authored-by: Ben Clark <ben@benjyc.uk>
Co-authored-by: Sam Spencer <43712250+samsp99@users.noreply.github.com>
Co-authored-by: chingon007 <76529461+chingon007@users.noreply.github.com>
Co-authored-by: Wouter Born <github@maindrain.net>
Co-authored-by: mueller-ma <mueller-ma@users.noreply.github.com>
Co-authored-by: aurelio1 <aurelio@caliaro.net>
Co-authored-by: Bernd Weymann <bernd.weymann@gmail.com>
Co-authored-by: Martin Hogg <hoggm2@hotmail.co.uk>
2021-05-15 15:11:12 +02:00
..
doc Partial merge final -> final-stable (#1569) 2021-05-15 15:11:12 +02:00
readme.md Updated external content (Jenkins build 1) 2020-09-21 11:33:32 +00:00

readme.md

id label title type description since install
habpanel HABPanel HABPanel - UIs ui HABPanel is a lightweight dashboard interface for openHAB. 3x auto

{% include base.html %}

HABPanel

HABPanel is a lightweight dashboard interface for openHAB.

It notably features an embedded dashboard designer allowing to build interfaces easily right on the target device.

Configuration

Unlike Basic UI and other interfaces, HABPanel doesn't use pre-configured sitemaps.

It can however store all its configuration (called panel configurations, including sets of dashboards, custom widgets definitions, and other settings) on the server as openHAB 2 service configuration variables.

You can access this server-side configuration in Paper UI, Configuration > Services > UI > HABPanel. From there, you can also lock down the embedded editing features globally to prevent accidental changes by end users. You can also specify the name of a known panel configuration to load immediately when starting to configure a brand new HABPanel instance; otherwise, the local browser's storage will be used only until you save a new panel configuration as detailed below.

Getting started

  • When accessing HABPanel for the first time on a new browser or device, you should be presented with a rather empty screen - follow the tutorial and begin by clicking (or tapping) on the top-right corner icon.
  • You're now in edit mode, a link ("Add new dashboard") appeared, as well as an "Advanced settings" link.
  • If you previously used HABPanel and stored some panel configurations on the server, go to "Advanced settings" and click on your previous configuration - it will be instantly brought back. Or, create your first dashboard: click/tap on the "Add new dashboard" link and give it a name.
  • Click/tap on the dashboard tile to enter the dashboard editor
  • Add your first widget: select the "Add Widget" menu and choose a widget type (let's say Dummy - a simple widget displaying an item's state)
  • Move the widget by drag-and-drop and resize it with the white chevron - it appears when you click on the widget
  • Hit on the three dots in the widget top-right corner to bring up its context menu and choose "Edit..."
  • Adjust some settings (name, openHAB item etc.) and confirm your changes
  • Save your configuration by clicking/tapping the Save button
  • Click/tap Run to see your dashboard in action - use your browser's back button or the arrow to go back to the drawing board
  • Once you're happy with your set of dashboards, go back to "Advanced settings" then click/tap on "Save the current configuration to a new panel configuration"; this will store it on the openHAB 2 server as described above, and make it available for reuse.

Screenshots