openhab-webui/bundles/org.openhab.ui.habot
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
..
docs improve Maven + Bnd layout and settings (#44) 2019-04-05 08:28:49 +02:00
src Start license headers with `/*` instead of `/**` (#2988) 2025-01-07 18:49:02 +01:00
web Update package.json versions of UIs to 4.0.0 (#1762) 2023-03-05 23:26:48 +01:00
.classpath Update Eclipse .classpath files (#1603) 2022-12-23 16:55:26 +01:00
.project improve Maven + Bnd layout and settings (#44) 2019-04-05 08:28:49 +02:00
CONTRIBUTING.md Upgrade from webpack v4 to v5 (#2267) 2024-01-31 00:32:56 +01:00
NOTICE Use "openhab" event topic prefix (#304) 2020-08-11 21:16:56 +02:00
README.md Use HTTPS links in Markdown (#1589) 2022-12-18 20:05:32 +01:00
archetype-settings.xml improve Maven + Bnd layout and settings (#44) 2019-04-05 08:28:49 +02:00
pom.xml Prepare for OH 5.0.0 (#2924) 2024-12-15 19:41:01 +01:00

README.md

HABot

HABot is a chatbot for openHAB, running inside the openHAB runtime with no dependency; it can run offline and keep your data out of third-party clouds, but works very well remotely if served from an openHAB Cloud instance (like myopenhab.org). In that scenario it can even be added to the Android homescreen as a Progressive Web App, and adds features working only on "secure origins" like push notifications, speech recognition and resource caching.

It consists in:

  • a machine-learning natural language processor based on Apache OpenNLP for intent classification and entity extraction (thanks to nlp-intent-toolkit);
  • a modular intent-based skill system with learning data provisioning (basic skills to retrieve item statuses, historical data and send basic commands are built-in, but more can be injected by other OSGi dependency injection);
  • a fully-featured responsive card-based user interface built with the Quasar Framework and its companion REST API to interact with the bot;
  • an openHAB Human Language Interpreter - this means once the natural language answers expand to more than "here's what I found" and "there you go", you will eventually be able to ask HABot questions and give it orders without a visual UI when coupled with speech-to-text and text-to-speech engines in openHAB, for instance to build privacy-focused specialized voice assistant.

It is another step to have a full, open source, privacy-focused, integrated natural language processing toolchain for your openHAB smart home.

Screenshots

Walkthrough Series

Follow the Walkthrough Series on the Community Forum to learn more HABot, its features and how to make the most out of it.