No Description

monf 8ea917529a [Tests] #234 player modularity tests 7 years ago
Docs 3e5c2b0fa9 [Feature] #234 Player modularity 7 years ago
Tests 8ea917529a [Tests] #234 player modularity tests 7 years ago
brain_examples f503f072ce [Review] Refacto, tests, typos 8 years ago
docker 549b1a63fc add debian 8 to the docker CI chain 8 years ago
images 473df782a6 led and mute button support for Rpi 7 years ago
install 8ea917529a [Tests] #234 player modularity tests 7 years ago
kalliope 8ea917529a [Tests] #234 player modularity tests 7 years ago
.gitignore b049dd38dc Split Cache & FileManager 8 years ago
.travis.yml 8ea917529a [Tests] #234 player modularity tests 7 years ago
CHANGELOG.md 93492a01f7 7 years ago
LICENSE.md a4dd9d2f16 8 years ago
MANIFEST.in 99899a7c83 Doc review + cleanup 8 years ago
README.md dc677f87fc add coveralls 8 years ago
kalliope.py a0335ba900 Add a valid development entry point kalliope.py at the root of the project. 8 years ago
setup.py 8ea917529a [Tests] #234 player modularity tests 7 years ago

README.md

Build Status Coverage Status Gitter

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!"    

Installation

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

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)

Improve models with Snowboy

Demo French : video Demo English : video

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.