No Description

ThiBuff e34ea08de7 [Feature] #427 Manage tts list for the settings neuron 6 years ago
Docs 54a85bb75f [Refactor] move RecognitionOptions to Options 6 years ago
Tests 54a85bb75f [Refactor] move RecognitionOptions to Options 6 years ago
brain_examples c85519513a [Refacto] rename settings mute to deaf 6 years ago
docker 6c3b899d56 add python 3 docker test = fix lifo metaclass 7 years ago
images 784f161389 7 years ago
install afeacd7f3f 6 years ago
kalliope e34ea08de7 [Feature] #427 Manage tts list for the settings neuron 6 years ago
.gitignore b049dd38dc Split Cache & FileManager 8 years ago
.travis.yml 41d7e803a8 7 years ago
CHANGELOG.md bc01067a4a release (#400) 6 years ago
LICENSE.md a4dd9d2f16 8 years ago
MANIFEST.in 99899a7c83 Doc review + cleanup 7 years ago
README.md afeacd7f3f 6 years ago
kalliope.py a0335ba900 Add a valid development entry point kalliope.py at the root of the project. 7 years ago
setup.py c1f7a1fc27 Feature/hooks (#388) 6 years ago

README.md

Kalliope

Build Status Coverage Status Gitter PyPI version PyPI Beerpay

Kalliope is a modular always-on voice controlled personal assistant designed for home automation. Kalliope is based on audio input recognition, so it recognize an order pronounced by the user and then execute actions attached to the order.

You can create your own Kalliope bot, by simply choosing and composing the existing modules without writing any code. But, if you need a particular module, you can write it by yourself and add it to your project. You can also propose it to the community.

Kalliope can run on all Linux Debian based distribution including a Raspberry Pi and it's multi-lang. The only thing you need is a microphone.

Kalliope is easy-peasy to use, see the hello world

  - name: "Hello-world"
    signals:
      - order: "say hello"
    neurons:      
      - say:
          message: "Hello world!"    

If you want an idea of what you can do with Kalliope, click on the image below ENGLISH DEMO

Installation

Just run the following bash command to install Kalliope on a freshly installed Raspberry Pi:

bash -c "$(curl -sL https://raw.githubusercontent.com/kalliope-project/kalliope/master/install/rpi_install_kalliope.sh)"

Or use:

Quick start

Once installed, you can start learning basics of Kalliope from a quick start configuration

Usage

Documentation summary

Link Detail
Settings The main Kalliope configuration
Brain What is the brain and how to create your own bot
neuron What is a neuron and how to use it
neuron list List of available neurons
CLI How to use Kalliope from the command line interface
Signals Signals are input event that can wake up kalliope (spoken order, scheduled event, REST API)
STT Speech to text configuration
TTS Text to speech configuration
Triggers Magic hotword engine used to make Kalliope listening for an order
REST API Integrated REST API. Can be used to send an order
Players Player is the software used to make kalliope talk

Contributing

If you'd like to contribute to Kalliope, please read our Contributing Guide, which contains the philosophies to preserve, tests to run, and more. Reading through this guide before writing any code is recommended.

Credits

Meaning of Kalliope Kalliope means "beautiful voice" from Greek καλλος (kallos) "beauty" and οψ (ops) "voice". In Greek mythology she was a goddess of epic poetry and eloquence, one of the nine Muses.

  • kə-LIE-ə-pee (English)
  • Ka-li-o-pé (French)
  • каллиопа (Russian)

Links

License

Copyright (c) 2016. All rights reserved.

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". For the full license text see the LICENSE.md file.