Explanation of Sitemaps

bbrendon edited this page Dec 27, 2016 · 51 revisions

feature overview

Installation

Setup intro

Linux and OS X

Windows

FreeBSD


Configuration

Automation*

User Interfaces

Persistence


Community

(link to openHAB forum)

Development


Bindings


Application Integration

Misc


Samples

A good source of inspiration and tips from users gathered over the years. Be aware that things may have changed since they were written and some examples might not work correctly.

Please update the wiki if you do come across any out of date information.

Binding configurations

Use case examples

Item definition examples

Sitemap definition examples

Collections of Rules on a single page

Single Rules

Scripts

Syntax highlighting for external editors


Release Notes

Clone this wiki locally

Introduction

This is a definition of "site map" from WhatIs.com:

A site map is a visual or textually organized model of a Web site's content that allows the users to navigate through the site to find the information they are looking for, just as a traditional geographical map helps people find places they are looking for in the real world. A site map is a kind of interactive table of contents, in which each listed item links directly to its counterpart sections of the Web site. Site maps perform the same service that the layout maps in large shopping malls perform: without them, it is possible to explore a complex site by trial and error, but if you want to be sure to find what you're looking for, the most efficient way to do that is to consult a model of the resources available.

By definition, a site map (or sitemap) is a list of pages of a web site accessible to users, a document that lists the pages on a website, typically organized in hierarchical fashion.

In openHAB, the term sitemap is used to refer to the document that lists the content of your automation system that will show on the user's screen.

Sitemaps are used to create elements of a user interface for making openHAB items accessible to various frontends. Sitemaps are a declarative UI definition. With a few lines it is possible to define the structure and the content of your UI screens.

Sitemap files

Sitemap files have the .sitemap filename extension and be stored in ${openhab_home}/configurations/sitemaps.

Default sitemap

It is possible to have multiple sitemaps on one installation, each accessible through their URL by appending their name to the sitemap URL: "http://localhost:8080/openhab.app?sitemap=SitemapNameGoesHere" To load one by default, name it default.sitemap and the sitemap element 'default' so you do not need to specify a sitemap parameter in your URL. The URL "http://localhost:8080/openhab.app" has the same behaviour as "http://localhost:8080/openhab.app?sitemap=default".

Demo

The openHAB runtime comes with a demo sitemap file, which should let you easily understand its structure.

openHAB Designer file editor

For easy editing, the openHAB Designer brings full IDE support for these files, so you can easily check the syntax and find out about the options you have. (Again, for the technically interested, this is also an Xtext DSL.)

Syntax

Sitemaps are composed by grouping various user interface elements into areas, which then will be rendered and presented by openHAB.

Example (Explaination):

sitemap demo label="Main Menu" {
    Frame label="Date" {
        Text item=Date
    }
    Frame label="Demo" {
        Text label="Group Demo" icon="1stfloor" {
            Switch item=Lights mappings=[OFF="All Off"]
            Group item=Heating
            Text item=Temperature valuecolor=[>25="orange",>15="green",<=15="blue"]
        }
        Text label="Multimedia" icon="video" {
            Selection item=Radio_Station mappings=[0=off, 1=HR3, 2=SWR3, 3=FFH, 4=Charivari]
            Slider item=Volume
        }
    }
}

Element 'Sitemap'

The sitemap element is mandatory in a sitemap definition. It will always be the first line. It states the name of your sitemap and the title of the main screen.

sitemap [sitemapname] [label="<title of the main screen>"]

The following elements can be used in a sitemap definition file (alphabetical order):

Element Description
Colorpicker Allows the user to choose a color from a color wheel
Chart Adds a time-series chart object for displaying logged data
Frame Area with either various other sitemap elements or further nested frames
Group Renders all elements of a given group defined in an items definiton file
Image Renders an image
List Not supported by any user interface
Selection Gives access to a new page where the user can choose among values defined in the mappings parameter
Setpoint Shows a value and allows the user to modify it. Optionally, it is possible to specify maximum and minimum allowed values, as well as a step
Slider Renders a slider
Switch Renders a switch item
Text Renders a text element
Video Displays a video
Webview Display a webpage

Element 'Colorpicker'

Colorpicker [item=<itemname>] [label="<labelname>"] [icon="<iconname>"] [sendFrequency=""]

Element 'Chart'

Chart [item=<itemname>] [icon="<iconname>"] [label="<labelname>"] [service="<service>"] [period=xxxx] [refresh=xxxx]
  • refresh is the refresh period of the image in milliseconds
  • service sets the persistence service to use. If no service is set, openHAB will use the first queryable persistence service it finds. Therefore, for an installation with only a single persistence service, this is not required.
  • period sets the length of the time axis of the chart. Valid values are h, 4h, 8h, 12h, D, 3D, W, 2W, M, 2M, 4M, Y
  • The following parameters are only available in v1.5 and over the HTTP(S) request: begin / end sets the begin / end of the time axis of the chart. Valid values are in this format: yyyyMMddHHmm (yyyy := year, MM := month, dd := day, HH := hour (0-23), mm := minutes).

Note that charts are rendered by a chart provider. By default, openHAB provides a default chart provider which will work with all queryable persistence services. Other chart providers can be user to render the chart by changing the chart:provider=default configuration in openhab.cfg to the name of the alternative provider. Currently, the only alternative is to use the rrd4j provider to render the graphs.

A few technical constraints and details to be aware of:

  • When using rrd4j persistence, you must use the everyMinute (60 seconds) logging strategy otherwise rrd4j thinks that there is no data and will not properly draw the charts.
  • When using chart:provider=rrd4j, the service=<service> is ignored and only the persistence service rrd4j is used.
  • Despite the chart refresh option, charts do not appear to refresh properly according to this setting
  • The visibility of multiple chart objects can be toggled to simulate changing the chart period, and the non-visible chart widgets are NOT generated behind the scenes until it becomes visible.
  • When charting a group of items make sure every label is unique. If the label contains spaces, the first word of the label must be unique. Identical labels result in an empty chart (as of 1.7.0).

Charts from rrd4j can also be generated and shown as images. Visit Charts in the Wiki for examples.

Element 'Frame'

Frames are used to create a visually separated area of items.

Frame [label="<labelname>"] [icon="<icon>"] [item=<item>]
{
    [additional sitemap elements]
}

Element 'Group'

A Group element creates a clickable area that opens up on a new page, where you can show various elements (including nested Groups).

Group [item=<itemname>] [label="<labelname>"] [icon="<iconname>"]

Note that all the parameters are optional, but if you don't specify at least one of them, the group will not appear in the interface (unlike the frame).

If you specify at least one parameter, the Group item will appear as a clickable white box. By clicking, you access a new page that shows the contents inside the group. Group items can be nested and mixed with frames: this gives a very powerful method to organise your information.

itemname can be a single item, or a item group: in the latter case, the new page will contain all items belonging to it.

If you don't set labelname but specify itemname, the group will get the label from the item. If you don't set both labelname and itemname, the group will appear as a blank box. You can see another effect of setting a labelname in the interface navigation bar: the left link that moves you to the previous level shows the text of labelname, or "Back" if the label is not specified.

Element 'Image'

Image [item=<itemname>] [icon="<iconname>"] url="<url of image>" [label="<labelname>"] [refresh=xxxx]

refresh is the refresh period of the image in milliseconds

Element 'List'

List item=<itemname> [label="<labelname>"] [icon="<iconname>"] [separator=""]

Splits a String item at each separator into multiple rows.

Note: Seems not supported by any user interface at the moment.

Element 'Selection'

Selection item=<itemname> [label="<labelname>"] [icon="<iconname>"] [mappings="<mapping definition>"]

An explanation for mappings you can find here.

Note: Selection renders the elements in the mappings as a list of texts in a separated page. If you prefer a list of buttons in the same page, then use Switch with an associated mapping.

Element 'Setpoint'

Setpoint item=<itemname> [label="<labelname>"] [icon="<iconname>"] minValue=<min value> maxValue=<max value> step=<step value>

Element 'Slider'

Slider item=<itemname> [label="<labelname>"] [icon="<iconname>"] [sendFrequency="frequency"] [switchSupport]
  • sendFrequency: Used for distinguishing between long and short button presses in the classic (web) frontend; this parameter defines the interval in miliseconds for sending increase/decrease requests
  • switchSupport: If specified a short press on the "up" or "down" button/arrow in the classic (web) frontend switched the item on/off completely

Element 'Switch'

Switch item=<itemname> [label="<labelname>"] [icon="<iconname>"] [mappings="<mapping definition>"]

You can find an explanation for mappings you can here. Also note that Switch elements with and without mapping are rendered differently in the interface.

Element 'Text'

Text item=<itemname> [label="<labelname>"] [icon="<iconname>"]

Element 'Video'

Video item=<itemname>  [icon="<iconname>"] url="<url of video to embed>" [encoding="<video encoding>"]

encoding is the video encoding. Be sure to specify "mjpeg" for MJPEG video. Leave empty for autoselection, but autoselection does not work properly for MJPEG.

Element 'Webview'

Webview item=<itemname> [label="<labelname>"] [icon="<iconname>"] url="<url>" [height=<heightvalue>]

height is the number of rows.

Mappings

Mappings can be used to let the user chose an item from a list.

mappings = [ "value1"="name1", "value2"="name2" ]

Quotes can be omitted if the value string and name string do not contain spaces.

Examples:

mappings = [ "1"="ON", "0"="OFF" ]
mappings = [ 1="BBC", 2="CNN", 3="BLOOMBERG" ]

Dynamic Sitemaps

Sitemaps can be designed to show items dynamically, or add colors depending on their state, or the state of another item. A few use cases for this are:

  • Hide elements of a heating system depending on its mode
  • Display different charts or URLs depending on the state of an item
  • Show a battery warning if the voltage is low
  • Highlight a value with a warning color if it's above or below limits

All widgets in the sitemap have the following three parameters available:

  • visibility
  • labelcolor
  • valuecolor

It is important to note that in all cases rules are parsed from left to right, and the first rule that returns true will take priority.

Visibility

To dynamically show or hide an item, the visibility tag is used. By default, an item is visible if the visibility tag is not provided. If provided, a set of rules are used to indicate the items visibility status. If any of the rules are true then the item will be visible, otherwise it will be hidden.

The format of the visibility tag is as follows:

visibility=[item_name operator value, ... ]

Multiple rules can be provided using a comma as a delimiter. Valid operators are the ==, >=, <=, !=, >, <.

Examples:

visibility=[Weather_Chart_Period!=ON]
visibility=[Weather_Chart_Period=="Today"]
visibility=[Weather_Chart_Period>1, Weather_Temperature!="Uninitialized"]

Colors

Colors can be used to emphasise an items label or its value.

The format of the labelcolor and valuecolor tags are as follows:

labelcolor=[item_name operator value = "color", ... ]

Multiple rules can be provided using a comma as a delimiter. Valid operators are the ==, >=, <=, !=, >, <.

itemname and operator are optional - if not provided, itemname will default to the current item and operator will default to ==. So the following three rules will all do the same thing, and all are valid.

Examples:

Text item=Weather_Temperature valuecolor=[22="green"]
Text item=Weather_Temperature valuecolor=[==22="green"]
Text item=Weather_Temperature valuecolor=[Weather_Temperature==22="green"]

openHAB supports a standard set of colors, based on the CSS definitions. This is a set of 17 colors that should be supported by any UI. The colors are defined by name, and within openHAB they are translated to the CSS color format (ie "#xxxxxx"). This should ensure a standard interface for these colors.

Below is a list of the standard colors and their respective CSS definitions. Note that case is not important.

Name used in sitemap Color provided in REST interface
MAROON #800000
RED #ff0000
ORANGE #ffa500
YELLOW #ffff00
OLIVE #808000
PURPLE #800080
FUCHSIA #ff00ff
WHITE #ffffff
LIME #00ff00
GREEN #008000
NAVY #000080
BLUE #0000ff
AQUA #00ffff
TEAL #008080
BLACK #000000
SILVER #c0c0c0
GRAY #808080

For any color other than those defined above, "color" is passed directly through to the UI, so its exact implementation is up to the UI. It is generally expected that valid HTML colors can be used (eg "green", "red", "#334455") but a UI could for example define abstract colors that are defined internally depending on the theme. For example, "warning" could be defined and used in a UI dependant way, but there is currently no standardisation of these terms.

Examples:

valuecolor=[>25="orange",>15="green",>5="orange",<5="blue"]
valuecolor=[Weather_LastUpdate=="Uninitialized"="lightgray",Weather_LastUpdate>600="lightgray",>15="green",>=10="orange",<10="red"]

Hint: for dynamic icons see the section on icons on the items page.

Example

You may find descriptions like:

sitemap demo label="Main Menu" {
    Frame label="Date" {
        Text item=Date
    }
    Frame label="Demo" {
        Text label="Group Demo" icon="1stfloor" {
            Switch item=Lights mappings=[OFF="All Off"]
            Group item=Heating
            Text item=Temperature valuecolor=[>25="orange",>15="green",<=15="blue"]
        }
        Text label="Multimedia" icon="video" {
            Selection item=Radio_Station mappings=[0=off, 1=HR3, 2=SWR3, 3=FFH, 4=Charivari]
            Slider item=Volume
        }
    }
}

Explanation:

  • The sitemap "demo" with the shown title "Main Menu" is defined.
  • One first frame with a datestamp is shown.
  • You want a frame with a visual label "Demo". Then, inside the frame you want two elements:
    • An item called Group Demo with 1stfloor icon that contains 4 items.
      • The first one is the group Lights, that has a mapping. It means that when it receives a value of OFF, it might show a "All off" text.
      • The second one will be the Heating group.
      • The third one will show a temperature with the value is colored acordingly
    • An item called Multimedia with icon video. It has two elements:
      • The Radio_station item that has several mappings
      • The Volume item, shown as an Slider.

A note about rule comparison

  • String comparisons are case sensitive, so ==ON is not the same as ==on.
  • DateTime comparisons are relative to the current time and specified in seconds. So a rule >300 will return true if the DateTime item is set to a value that's newer than the past 5 minutes (300 seconds).

Further examples for defining sitemaps can be found in our openHAB-Samples section.