No Description

nico 847e56b3ff 8 years ago
Docs 920c7baea9 neuron.md review 8 years ago
brain_examples 402f1bbc37 8 years ago
brains 36c4dba6d4 8 years ago
core 847e56b3ff 8 years ago
install c130e49c6d [Feature] Singleton Brain 8 years ago
neurons 42f02d9a1f [Doc] Docstrings of neurons package 8 years ago
sounds e62d39e600 8 years ago
stt 6f87d36b9c [Doc] Docstrings of STT package 8 years ago
templates 07507266b3 8 years ago
trigger 6f8939bf1b 8 years ago
tts e60d2a8524 [Doc] Docstrings of TTS package 8 years ago
.gitignore b049dd38dc Split Cache & FileManager 8 years ago
LICENSE.md a4dd9d2f16 8 years ago
README.md b55a25bc19 8 years ago
brain.yml 9a79bb11af 8 years ago
kalliope.py 63577433e8 [Doc] Docstrings of core package 8 years ago
settings.yml 36c4dba6d4 8 years ago
tasks.yml b73c5224b4 8 years ago
test.py a8b4c6fe1d [Feature] Singleton Settings 8 years ago

README.md

Kalliope

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 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"
    neurons:      
      - say:
          message: "Hello world!"
    signals:
      - order: "say hello"

Installation

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 availlable 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 listtening 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. PRONOUNCED: kə-LIE-ə-pee (English) PRONOUNCED: Ka-li-o-pé (French)

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.