Picovoice WordmarkPicovoice Console
Introduction
Introduction
AndroidC.NETFlutterlink to GoiOSJavaNvidia JetsonLinuxmacOSNodejsPythonRaspberry PiReact NativeRustWebWindows
AndroidC.NETFlutterlink to GoiOSJavaNodejsPythonReact NativeRustWeb
SummaryPicovoice LeopardAmazon TranscribeAzure Speech-to-TextGoogle ASRGoogle ASR (Enhanced)IBM Watson Speech-to-Text
FAQ
Introduction
AndroidC.NETFlutterlink to GoiOSJavaNodejsPythonReact NativeRustWeb
AndroidC.NETFlutterlink to GoiOSJavaNodejsPythonReact NativeRustWeb
FAQ
Introduction
AndroidCiOSLinuxmacOSPythonWebWindows
AndroidCiOSPythonWeb
SummaryOctopus Speech-to-IndexGoogle Speech-to-TextMozilla DeepSpeech
FAQ
Introduction
AndroidAngularArduinoBeagleBoneCChrome.NETEdgeFirefoxFlutterlink to GoiOSJavaNvidia JetsonLinuxmacOSMicrocontrollerNodejsPythonRaspberry PiReactReact NativeRustSafariUnityVueWebWindows
AndroidAngularC.NETFlutterlink to GoiOSJavaMicrocontrollerNodejsPythonReactReact NativeRustUnityVueWeb
SummaryPorcupineSnowboyPocketSphinx
Wake Word TipsFAQ
Introduction
AndroidAngularBeagleBoneCChrome.NETEdgeFirefoxFlutterlink to GoiOSJavaNvidia JetsonlinuxmacOSNodejsPythonRaspberry PiReactReact NativeRustSafariUnityVueWebWindows
AndroidAngularC.NETFlutterlink to GoiOSJavaNodejsPythonReactReact NativeRustUnityVueWeb
SummaryPicovoice RhinoGoogle DialogflowAmazon LexIBM WatsonMicrosoft LUIS
Expression SyntaxFAQ
Introduction
AndroidBeagleboneCiOSNvidia JetsonLinuxmacOSPythonRaspberry PiRustWebWindows
AndroidCiOSPythonRustWeb
SummaryPicovoice CobraWebRTC VAD
FAQ
Introduction
AndroidCiOSPythonWeb
AndroidCiOSPythonWeb
SummaryPicovoice KoalaMozilla RNNoise
Introduction
AndroidAngularArduinoBeagleBoneC.NETFlutterlink to GoiOSJavaNvidia JetsonMicrocontrollerNodejsPythonRaspberry PiReactReact NativeRustUnityVueWeb
AndroidAngularCMicrocontroller.NETFlutterlink to GoiOSJavaNodejsPythonReactReact NativeRustUnityVueWeb
Picovoice SDK - FAQ
IntroductionSTM32F407G-DISC1 (Arm Cortex-M4)STM32F411E-DISCO (Arm Cortex-M4)STM32F769I-DISCO (Arm Cortex-M7)IMXRT1050-EVKB (Arm Cortex-M7)
FAQGlossary

Porcupine Wake Word
Rust Quick Start


Platforms

  • Linux (x86_64)
  • macOS (x86_64, arm64)
  • Windows (x86_64)
  • BeagleBone
  • NVIDIA Jetson Nano
  • Raspberry Pi (Zero, 2, 3, 4)

Requirements

  • Picovoice Account & AccessKey
  • Rust 1.54+
  • Cargo

Picovoice Account & AccessKey

Signup or Login to Picovoice Console to get your AccessKey. Make sure to keep your AccessKey secret.

Quick Start

Setup

  1. Download and install Rust .

  2. Add pv_porcupine to the Cargo.toml manifest:

[dependencies]
pv_porcupine = "*"

Usage

Create an instance of Porcupine that detects the included built-in wake words porcupine and bumblebee:

use porcupine::{Porcupine, BuiltinKeywords, PorcupineBuilder};
let porcupine: Porcupine = PorcupineBuilder::new_with_keywords(
"${ACCESS_KEY}",
&[BuiltinKeywords::Porcupine, BuiltinKeywords::Bumblebee],
)
.init()
.expect("Unable to create Porcupine");

Pass in frames of audio to the .process function:

fn next_audio_frame() -> Vec<i16> {
// ..
}
loop {
let audio_frame: Vec<i16> = next_audio_frame();
if let Ok(keyword_index) = porcupine.process(&audio_frame) {
if keyword_index == 0 {
// `porcupine` detected
} else if keyword_index == 1 {
// `bumblebee` detected
}
}
}

Custom Keywords

Create custom keywords using the Picovoice Console . Download the custom wake word file (.ppn) and create an instance of Porcupine using the new_with_keyword_paths builder method:

let porcupine: Porcupine = PorcupineBuilder::new_with_keyword_paths(
"${ACCESS_KEY}",
&["${KEYWORD_FILE_PATH}"],
)
.init()
.expect("Unable to create Porcupine");

Non-English Languages

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 builder method to change the detection language:

let porcupine: Porcupine = PorcupineBuilder::new_with_keyword_paths(
"${ACCESS_KEY}",
&["${KEYWORD_FILE_PATH}"],
)
.model_path("${MODEL_FILE_PATH}")
.init()
.expect("Unable to create Porcupine");

Demo

For the Porcupine Rust 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.

Setup

Clone the Porcupine GitHub Repository :

git clone --recurse-submodules https://github.com/Picovoice/porcupine.git

Usage

Use the --help flag to see the usage options for the demo:

cd porcupine/demo/rust/micdemo
cargo run --release -- --help

Ensure you have a working microphone connected to your system and run the following command to detect the built-in keyword porcupine:

cargo run --release -- --access_key "${ACCESS_KEY}" --keywords porcupine

For more information on our Porcupine demos for Rust, head over to our GitHub repository .

Resources

Package

  • pv_porcupine on crates.io

API

  • pv_porcupine Rust API Docs

GitHub

  • Porcupine Rust SDK on GitHub
  • Porcupine Rust Demos on GitHub

Benchmark

  • Wake Word Benchmark

Was this doc helpful?

Issue with this doc?

Report a GitHub Issue
Porcupine Wake Word Rust Quick Start
  • Platforms
  • Requirements
  • Picovoice Account & AccessKey
  • Quick Start
  • Setup
  • Usage
  • Custom Keywords
  • Non-English Languages
  • Demo
  • Setup
  • Usage
  • Resources
Platform
  • Leopard Speech-to-Text
  • Cheetah Streaming Speech-to-Text
  • Octopus Speech-to-Index
  • Porcupine Wake Word
  • Rhino Speech-to-Intent
  • Cobra Voice Activity Detection
Resources
  • Docs
  • Console
  • Blog
  • Demos
Sales
  • Pricing
  • Starter Tier
  • Enterprise
Company
  • Careers
Follow Picovoice
  • LinkedIn
  • GitHub
  • Twitter
  • Medium
  • YouTube
  • AngelList
Subscribe to our newsletter
Terms of Use
Privacy Policy
© 2019-2022 Picovoice Inc.