Porcupine Wake Word
Python Quick Start
- Linux (x86_64)
- macOS (x86_64, arm64)
- Windows (x86_64)
- NVIDIA Jetson Nano
- Raspberry Pi (Zero, 2, 3, 4)
- Picovoice Account & AccessKey
- Python 3
Picovoice Account & AccessKey
Signup or Login to Picovoice Console to get your
Make sure to keep your
Create an instance of Porcupine that detects the included built-in wake words
Pass in frames of audio to the
Release resources explicitly when done with Porcupine:
Create custom keywords using the Picovoice Console .
Download the custom wake word file (
.ppn) and create an instance of Porcupine using the
keyword_paths input argument:
Use the corresponding model file (
.pv) to detect non-English wake words.
The model files for all supported languages are available
on the Porcupine GitHub repository .
Pass in the model file using the
model_path input argument to change the detection language:
For the Porcupine Python SDK, we offer demo applications that demonstrate how to use the wake word engine on real-time audio streams (i.e. microphone input) and audio files.
Install the pvporcupinedemo Python package using PIP:
This package installs command-line utilities for the Porcupine Python demos.
--help flag to see the usage options for the demo:
Ensure you have a working microphone connected to your system and run the following command to detect the built-in keyword
For more information on our Porcupine demos for Python, head over to our GitHub repository .