Skip to content

andweber/loxberry-plugin-kalliope

Repository files navigation

LoxBerry Plugin Kalliope LoxSControl

Build Status Gitter

Synopsis

A LoxBerry Plugin providing a Kalliope installation for the LoxBerry. A LoxBerry is an easy to install Raspberry Pi intented for home automation.

A LoxBerry with this plugin can be used to voice control a Loxone Homeautomation. Be aware: Kalliope is an always-on speech assistant. Meaning the micro is used to catch a keyword (this step is local), commands spoken after the keyword are recorded and processed by Kalliope. In the default configuration the speech recognition is done by using cloud-services.

For Details visit http://www.loxwiki.eu or Kalliope.

This project is a non-commercial community project and not connected to the company Loxone. Source Code of LoxBerry can be found on GitHub.

Required Hardware

/!\ You need to have a running LoxBerry installation with a microphone and an audio output connected. You can get the latest version from https://download.loxberry.de/. Consult the installation instructions for more details. For issues with audio or microphone the audio guide may help.

In case you want to use a Google AIY-Voicekit as hardware - you find some tipps in the AIY Voicekit tutorial.

Installation

You can download the last stable version of this plugin from master branch or the releases pages. For the development version download the dev branch.

Navigate in the LoxBerry Webfrontend to Plugin-Installation, select the downloaded *.zip and install the plugin. The first install will take some time, because of the dependencies needed to build.

Navigate to the plugin configuration site and configure the plugin. Help is available at the configure guide.

Finally restart the LoxBerry.

Usage

The Webfrontend provides some hints for the usage of Kalliope. For any further documentation about the usage of Kalliope, please refer to the Kalliope project.

The Kalliope brain is stored in the plugin config folder and can be adjusted and improved as needed. /!\ usr_bain folder is preserved during plugin update. Use this folders for adjustments and extensions. All other config files may be overriden during plugin update.

For advanced users the user templates can be stored in the plugin data folder usr_templates. This folder is also preserved during plugin update.

RoadMap

Version 0.5.1

  • [Done] Improved Webfrontend
  • [Done] use global variables in synapses (0.4.3 feature)
  • [Done] Update auf kalliope 5.2
  • [Done] Update auf LoxBerry 1.2.5
  • [Done] Plugin upgrade is possible
  • [Done] Proof of Voice Control Kalliope
  • [Done] Proof of Voice Control of Loxone
  • [Done] Various small fixes and improvements

Version 0.6

  • Advanced configuring of Kalliope using the webfrontend (Support multiple Miniserver, Trigger Selection, etc.)

Future feature collection

  • Edit brain using webfrontend
  • Install neurons/plugins using webfrontend
  • something more

Contribution

If you'd like to contribute to the project you can:

Notes

License

Copyright (c) 2017. All rights reserved. The install scripts are covery by the MIT license.

Loxone is a registered trademark by the loxone company. See www.loxone.com.

Kalliope is covered by the MIT license, a permissive free software license that lets you do anything you want with the source code, as long as you provide back attribution and "don't hold you liable".

LoxBerry is covered by the Apache License Version 2.0.