openHAB

This page is part of archived documentation for openHAB 3.4. Go to the current stable version

# Transformations

Transformations are used to translate data from a cluttered or technical raw value to a processed or human-readable representation. They are often useful, to interpret received Item values, like sensor readings or state variables, and to translate them into a human-readable or better processible format.

Examples:

  • Translation of a technical Binding output, e.g., "CLOSED" can be translated to the Spanish translation "cerrado"
  • Processing of a raw Item value, e.g., Parsing a number from a JSON string, like { "temperature": 23.2 }
  • Conversion of sensor readings, e.g., temperature in degree Celsius can be converted to degree Fahrenheit

# Usage

Transformations are applicable in Item and Sitemap element labels and inside DSL rules. The relevant transformation service needs to be installed via the paperUI before use. Be aware, that some Transformation services rely on transformation files, while others work by directly providing the transformation logic. Transformation files need to be placed in the directory $OPENHAB_CONF/transform.

  1. Item and Sitemap Labels

    Transformations used in the state/value part of labels are applied on the fly. While the transformed value will (for example) be visible on a Sitemap, the original value is stored in the Item.

    The following example shows a Map transformation (see below) used in the State part of an Item's label. The technical state of a Contact Item (e.g. "CLOSED") is translated into a human readable representation in Spanish ("cerrado").

    Contact Livingroom_Window        "Window [MAP(window_esp.map):%s]"               {/*Some Binding*/}
Number  Kitchen_Temperature_C    "Temperature [JSONPATH($.temperature):%s °C]" {/*Some Binding*/}
Number  Livingroom_Temperature_F "Temperature [JS(convert-C-to-F.js):%s °F]"   {/*Some Binding*/}

    Usage of Transformations in the label parameter of Sitemap elements works the same way.

  2. Rules

    Transformations can also be used in rules to transform/translate/convert data. The following shows three examples:

    var condition = transform("MAP", "window_esp.map", "CLOSED")
var temperature = transform("JSONPATH", "$.temperature", jsonstring)
var fahrenheit = transform("JS", "convert-C-to-F.js", temperature)

  3. Bindings

    Transformations can sometimes be used in binding add-ons. For example, transforming an openHAB ON command into "action=powerup" for sending to a device. If, and how, this use may be available is described in individual binding documentation.

  4. Profiles

    Transformations can be associated with channels, working on data being passed between bindings and Items. See profile documentation for more detail.

To keep these examples simple, the contents of the referenced files window_esp.map and convert-C-to-F.js were left out.

# SCRIPT Transformation

The SCRIPT transformation is available from the framework and needs no additional installation. It allows transforming values using any of the available scripting languages in openHAB (JSR-223 or DSL).

The script needs to be placed in the $OPENHAB_CONF/transform folder with an extension .script regardless of the actual script type. When referencing a transformation, the script type must be prepended to the filename (e.g. dsl:stringlength.script for the DSL version of stringlength.script). Please note that you cannot have transformations with the same name and different languages as the file-extension is always script. The script type depends on the scripting engine used, it is usually either the file extension or the MIME-type of the scripts.

The input value is injected into the script context as a string variable input. The result needs to be returned from the script, it can be null or a value of a type that properly implements .toString(). Additional parameters can be injected in the script by adding them to the script identifier in URL style (js.script:scale?correctionFactor=1.1&divider=10 would also inject correctionFactor and divider).

The examples show a simple transformation with the same functionality for some languages. It takes the length of the input string and e.g. returns String has 5 characters. Given the filename stringlength.script, the transformation pattern is SCRIPT(<script-type>:stringlength.script):%s.

    Currently the SCRIPT transformation is not available as profile.

    Caught a mistake or want to contribute to the documentation? Edit this page on GitHub (opens new window)

    ← Actions →