openhab-webui/bundles/org.openhab.ui.basic
Wouter Born 824bbc4711
Start license headers with `/*` instead of `/**` (#2988)
Prevents JavaDoc tooling issues because these tools check comments
starting with `/**`.

Depends on #2987

Signed-off-by: Wouter Born <github@maindrain.net>
2025-01-07 18:49:02 +01:00
..
doc improve Maven + Bnd layout and settings (#44) 2019-04-05 08:28:49 +02:00
snippets-src [BasicUI] Replace OK by CLOSE in the 2 color pop-ups (#2895) 2024-12-07 12:38:54 +01:00
src/main Start license headers with `/*` instead of `/**` (#2988) 2025-01-07 18:49:02 +01:00
web-src [BasicUI] Align and optimize available space for switch with mappings (#2388) 2024-11-30 14:12:34 +01:00
.classpath Update Eclipse .classpath files (#1603) 2022-12-23 16:55:26 +01:00
.gitignore [BasicUI] Add build date to resource requests (#2703) 2024-08-21 21:42:47 +02:00
.project improve Maven + Bnd layout and settings (#44) 2019-04-05 08:28:49 +02:00
BasicUI Setup.launch Switch to Java 11 and drop Java 8 support (#160) 2020-01-12 22:33:58 +01:00
CONTRIBUTING.md [BasicUI] Update CONTRIBUTING.md (#2737) 2024-08-31 18:45:48 +02:00
NOTICE [basicui] Remove roboto font leftovers (#1719) 2023-02-21 19:45:46 +01:00
README.md [BasicUI] Add more examples of valid/invalid URLs in README (#1823) 2023-05-09 12:07:21 +02:00
eslint.json improve Maven + Bnd layout and settings (#44) 2019-04-05 08:28:49 +02:00
gulpfile.js [BasicUI] Upgrade node/npm/gulp/node-sass tools (#2722) 2024-08-31 18:39:53 +02:00
package-lock.json [BasicUI] Upgrade node/npm/gulp/node-sass tools (#2722) 2024-08-31 18:39:53 +02:00
package.json [BasicUI] Upgrade node/npm/gulp/node-sass tools (#2722) 2024-08-31 18:39:53 +02:00
pom.xml Prepare for OH 5.0.0 (#2924) 2024-12-15 19:41:01 +01:00

README.md

Basic UI

The Basic UI is a web interface based on Material Design Lite from Google.

Features

  • Responsive layout suitable for various screen sizes
  • AJAX navigation
  • Live update

Configuration

org.openhab.basicui:defaultSitemap=demo
# Icons can be disabled
org.openhab.basicui:enableIcons=true
# Icons can be shown as PNG or SVG images
# Default: PNG
org.openhab.basicui:iconType=svg

Accessing Sitemaps

The Basic UI has a default layout showing all things and their corresponding items. You may create your own sitemaps and access them through the basic UI in 2 ways.

  1. Set the default sitemap via the UI via Settings -> Basic UI -> Configure, and set the Default Sitemap name.

  2. Passing the "sitemap" parameter to the URL used to access the server.

Examples:

  1. http://hostname:8080/basicui/app is a valid URL to load your default sitemap or to get a page listing all defined sitemaps when no default sitemap is configured.
  2. http://hostname:8080/basicui/app?sitemap=sitemapname is a valid URL to load a particular sitemap.
  3. http://hostname:8080/basicui/app/ is an invalid URL due to trailing slash.
  4. http://hostname:8080/basicui/app?sitemap=sitemapname/ is an invalid URL due to trailing slash.

Screenshots:

Screenshot 1 Screenshot 2