https://github.com/fwcd/okpi

Virtual assistant with offline voice recognition for Raspberry Pi
https://github.com/fwcd/okpi

pocketsphinx raspberry-pi speech-assistant speech-recognition

Last synced: 9 months ago
JSON representation

Virtual assistant with offline voice recognition for Raspberry Pi

• Host: GitHub
• URL: https://github.com/fwcd/okpi
• Owner: fwcd
• License: mpl-2.0
• Created: 2019-01-27T16:17:41.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-02-15T19:28:50.000Z (almost 7 years ago)
• Last Synced: 2025-03-31T20:39:10.859Z (10 months ago)
• Topics: pocketsphinx, raspberry-pi, speech-assistant, speech-recognition
• Language: TypeScript
• Homepage:
• Size: 140 KB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# OkPi

Virtual assistant with offline voice recognition. Despite being primarily designed for Raspberry Pi, it should compile on any computer running Linux or macOS.

## Installation

### Pocket Sphinx

* The PocketSphinx installation currently requires Node.js 6

    * This can be achieved by using a version manager such as [nvm](https://github.com/creationix/nvm):

        * `nvm install 6`

* Install the [PocketSphinx](https://github.com/cmusphinx/node-pocketsphinx) [dependencies](https://github.com/cmusphinx/node-pocketsphinx#installation):

    * `apt-get install cmake pkg-config libpcre3-dev bison`

    * [`swig` from GitHub](https://github.com/swig/swig)

    * [`sphinxbase` from GitHub](https://github.com/cmusphinx/sphinxbase)

    * [`pocketsphinx` from GitHub](https://github.com/cmusphinx/pocketsphinx)

    * Note that certain tweaks might be required prior to install:

        * `export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig`

        * `ln -s /usr/bin/swig3.0 /usr/bin/swig` (Create a symlink for `swig3.0`)

    * `npm install cmake-js -g`

### Say.js

* Install Festival with a default voice:

    * `apt-get install festival festvox-rablpc16k`

### NPM Dependencies

* `npm install`

## Launching

* Make sure that this repository (`OkPi`) is in the same folder as the cloned [`pocketsphinx` repository](https://github.com/cmusphinx/pocketsphinx)

* `npm run start`

    * Or alternatively using watch mode:

    * `npm run watch`

    * `npm run launch` (in a separate terminal)

## Architecture

* The application roughly implements the following structure:

* Speech input 

    * -> `AudioInput`

    * -> `SpeechRecognitionEngine`

    * -> `UtteranceProcessor`

    * -> `Skill`

    * -> `OutputFacade`